Api descriptions

PreviousAuth credentials NextApi keys

Was this helpful?

get

Authorizations

Path parameters

idinteger · int64required

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.laminar.run/api-descriptions/{id}' \
  --header 'Authorization: Bearer JWT'

200

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

delete

Authorizations

Path parameters

idinteger · int64required

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.laminar.run/api-descriptions/{id}' \
  --header 'Authorization: Bearer JWT'

200

No body

post

Authorizations

Body

urlstringrequired

methodTypestring · enumrequired

Available options:

authCredentialIdinteger · int64required

workspaceIdinteger · int64required

namestringrequired

descriptionstringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.laminar.run/api-descriptions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "text",
    "methodType": "GET",
    "authCredentialId": 1,
    "workspaceId": 1,
    "name": "text",
    "description": "text"
  }'

200

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

put

Authorizations

Body

apiDescriptionIdinteger · int64required

urlstringoptional

methodTypestring · enumoptional

Available options:

authCredentialIdinteger · int64optional

namestringoptional

descriptionstringoptional

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.laminar.run/api-descriptions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "apiDescriptionId": 1,
    "url": "text",
    "methodType": "GET",
    "authCredentialId": 1,
    "name": "text",
    "description": "text"
  }'

200

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