Sign in
Custom API Management

Update Custom Api

Update an existing Custom API.

put/api/custom-apis/{api_id}

Path parameters

api_idinteger required

Request body

namestring nullable

API name

descriptionstring nullable

API description

urlstring nullable

API URL

methodstring nullable

HTTP method

headersobject nullable

HTTP headers

bodystring nullable

HTTP body (JSON template)

envobject nullable

Environment variables (secrets)

is_activeboolean nullable

Whether the API is active

Response

Successful Response

idinteger required
user_idinteger required
namestring required
descriptionstring nullable required
urlstring nullable required
methodstring nullable required
headersobject nullable required
bodystring nullable required
envobject nullable required
is_activeboolean required
is_defaultboolean required
created_atstring required
updated_atstring required

Changes

Changed in 2 of the 4 revisions of this API.3