Sync collection with schema

Deprecated

PUT

/apis/:apiId/collections/:collectionId/sync-with-schema-tasks

Syncs a collection attached to an API with the API schema.

This is an asynchronous endpoint that returns an HTTP 202 Accepted response. The response contains a polling link to the /apis/{apiId}/tasks/{taskId} endpoint in the Location header.

Note:

This endpoint only supports the OpenAPI 3 schema type.

Syncs a collection attached to an API with the API schema. This is an asynchronous endpoint that returns an HTTP `202 Accepted` response. The response contains a polling link to the `/apis/{apiId}/tasks/{taskId}` endpoint in the `Location` header. **Note:** This endpoint only supports the OpenAPI 3 schema type.

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

apiIdstringRequired

The API's ID.

collectionIdstringRequiredformat: "uid"

The collection's unique ID.

Response headers

Locationstring

The URL to get or poll the status of an API version task created.

Response

Accepted

taskIdstring

The created task ID. You can use this ID to track the status of syncing an API collection with an API schema.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error