API ReferenceSpecs

Update a spec's properties

View as Markdown
Updates an API specification's properties, such as its name.

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

specIdstringRequired
The spec's ID.

Request

This endpoint expects an object.
namestringRequired
The spec's name.

Response

Spec Updated
idstring
The specification's ID.
typeenum
The type of API specification.
createdByinteger
The ID of the user that created the specification.
updatedByinteger
The ID of the user that last updated the specification.
createdAtdatetime
The date and time at which the specification was created.
updatedAtdatetime
The date and time at which the specification was last updated.
namestring
The API specification's name.

Errors

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