API ReferenceAPI

Update an API

Deprecated
View as Markdown
Updates an API.

Authentication

x-api-keystring
API Key authentication via header
OR
Authorizationstring
A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.
OR
AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

apiIdstringRequired
The API's ID.

Headers

AcceptenumRequired

The application/vnd.api.v10+json request header required to use the endpoint.

Allowed values:

Request

This endpoint expects an object.
namestringRequired
The API's name.
summarystringOptional
The API's short summary.
descriptionstringOptional
The API's description. This supports Markdown formatting.

Response

Successful Response
namestring
The API's name.
idstring
The API's ID.
summarystring
The API's summary.
createdAtdatetime
The date and time at which the API was created.
createdBystring
The user ID of the user that created the API.
updatedAtdatetime
The date and time at which the API was last updated.
updatedBystring
The user ID of the user that updated the API.
descriptionstring
The API's description. This supports Markdown formatting.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error