Create an access schedule
/products/{product_id}/access-schedulesCreates an access schedule for the product, identified by the supplied tag.
Each tag and product pair has at most one access schedule. If one already exists for the pair, the existing schedule is returned with 200 OK and no new schedule is created.
Access schedules cannot be created for replicated products; these requests return the replica_readonly error code.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.
Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.
length <= 64Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/products/string/access-schedules" \ -H "Content-Type: application/json" \ -d '{ "tag_id": "string" }'{ "data": { "created_at": "2019-08-24T14:15:22Z", "default": true, "deleted": true, "deliveries": [ { "id": "string" } ], "deliveries_count": 0, "id": "string", "name": "string", "object": "access_schedule", "product_id": "string", "revision": "string", "rules_count": 0, "tag_id": "string", "updated_at": "2019-08-24T14:15:22Z" }}List access schedules GET
Lists the access schedules of a product. Results are paginated with a cursor.
Retrieve an access schedule GET
Retrieves an access schedule by its public ID, including the deliveries that use it (`deliveries[]`). The response includes an `ETag` representing the current revision of the access schedule. Send this value in the `If-Match` header when updating the access schedule or its release rules to avoid overwriting a newer version.