Sync spec with collection

PUT

/specs/:specId/synchronizations

Syncs an API specification linked to a collection. This is an asynchronous endpoint that returns an HTTP 202 Accepted response.

Note:

This endpoint only supports the OpenAPI 2.0, 3.0, and 3.1 specification types.
You can only sync collections generated from the given specification ID.

Syncs an API specification linked to a collection. This is an asynchronous endpoint that returns an HTTP `202 Accepted` response. **Note:** - This endpoint only supports the OpenAPI 2.0, 3.0, and 3.1 specification types. - You can only sync collections generated from the given specification ID.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

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.

AuthorizationBasic

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

Path parameters

specIdstringRequired

The spec's ID.

Query parameters

collectionUidstringRequiredformat: "uid"

The collection's unique ID.

Response

Successful Response

taskIdstring

The created task ID. You can use this ID to track the status of the task.

urlstring

The URL to get or poll the status of a generated spec task.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error