Laminar
  • Laminar
  • Platform
    • Overview
    • Getting Started
    • Advanced
      • Configurations
      • HTTP Request Batching
      • Workflow Exit Points
      • Invoke Secondary Workflows
      • Managing Notifications
    • Best Practices
    • Keywords
      • lam.resolveThenExecute
      • lam.exit
      • lam.execute
      • lam.asyncExecute
      • lam.httpRequest
      • lam.httpRequests
  • Concepts
    • Workflows
      • Global Workflow Object
    • Flows
      • Flow Types
        • HTTP Request
        • Data Transformations
      • Flow Runs
    • API Key
    • Configurations
    • API
      • Reference
        • Workspaces
          • Issues
          • Users
          • Invitations
            • Decline
            • Accept
            • Received
            • Created
          • Workflows
          • Flows
          • Auth credentials
          • Api keys
          • Api descriptions
        • Workflow
          • Execute
            • External
          • Flows
          • Executions
        • Users
        • Flows
          • Runs
          • Versions
          • Stats
          • Recent runs
          • Read
        • Configurations
          • Properties
          • Flow credentials
          • Workspace
        • Auth credentials
        • Api descriptions
        • Api keys
        • Transform
          • Test
        • Lami
          • Public
          • Direct
        • Auth
          • Signin
          • Register
          • Refresh
          • Me
          • Users
            • Password
    • Changelog
  • External Links
    • Book a Demo
    • Playground
    • Sign In
  • Specification
Powered by GitBook
On this page

Was this helpful?

  1. Concepts
  2. API
  3. Reference

Api descriptions

PreviousAuth credentialsNextApi keys

Was this helpful?

get
Authorizations
Path parameters
idinteger · int64Required
Responses
get
GET /api-descriptions/{id} HTTP/1.1
Host: api.laminar.run
Authorization: Bearer JWT
Accept: */*
200

OK

{
  "id": 1,
  "url": "text",
  "methodType": "GET",
  "authCredentials": {
    "id": 1,
    "name": "text",
    "authType": "text"
  },
  "name": "text",
  "description": "text"
}
delete
Authorizations
Path parameters
idinteger · int64Required
Responses
delete
DELETE /api-descriptions/{id} HTTP/1.1
Host: api.laminar.run
Authorization: Bearer JWT
Accept: */*
200

OK

No content
  • POST/api-descriptions
  • PUT/api-descriptions
  • GET/api-descriptions/{id}
  • DELETE/api-descriptions/{id}
post
Authorizations
Body
urlstringRequired
methodTypestring · enumRequiredPossible values:
authCredentialIdinteger · int64Required
workspaceIdinteger · int64Required
namestringRequired
descriptionstringRequired
Responses
post
POST /api-descriptions HTTP/1.1
Host: api.laminar.run
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "url": "text",
  "methodType": "GET",
  "authCredentialId": 1,
  "workspaceId": 1,
  "name": "text",
  "description": "text"
}
200

OK

{
  "id": 1,
  "url": "text",
  "methodType": "GET",
  "authCredentials": {
    "id": 1,
    "name": "text",
    "authType": "text"
  },
  "name": "text",
  "description": "text"
}
put
Authorizations
Body
apiDescriptionIdinteger · int64Required
urlstringOptional
methodTypestring · enumOptionalPossible values:
authCredentialIdinteger · int64Optional
namestringOptional
descriptionstringOptional
Responses
put
PUT /api-descriptions HTTP/1.1
Host: api.laminar.run
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "apiDescriptionId": 1,
  "url": "text",
  "methodType": "GET",
  "authCredentialId": 1,
  "name": "text",
  "description": "text"
}
200

OK

{
  "id": 1,
  "url": "text",
  "methodType": "GET",
  "authCredentials": {
    "id": 1,
    "name": "text",
    "authType": "text"
  },
  "name": "text",
  "description": "text"
}