API Descriptions

PreviousAuth Credentials NextAPI Keys

Was this helpful?

post

/api-descriptions

Authorizations

Body

urlstringrequired

authCredentialIdinteger · int64required

workspaceIdinteger · int64required

namestringrequired

descriptionstringrequired

methodTypestring · enumrequired

Options: GET, POST, PUT, DELETE

Responses

*/*

cURL

JavaScript

Python

HTTP

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

200

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

put

/api-descriptions

Authorizations

Body

apiDescriptionIdinteger · int64required

urlstring

authCredentialIdinteger · int64

namestring

descriptionstring

methodTypestring · enum

Options: GET, POST, PUT, DELETE

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://lamapi3.azurewebsites.net/api-descriptions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"apiDescriptionId":1,"methodType":"GET"}'

200

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

get

/api-descriptions/{id}

Authorizations

Path parameters

idinteger · int64required

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://lamapi3.azurewebsites.net/api-descriptions/{id}' \
  --header 'Authorization: Bearer JWT'

200

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

delete

/api-descriptions/{id}

Authorizations

Path parameters

idinteger · int64required

Responses

cURL

JavaScript

Python

HTTP

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

200

No body