Developers
Products

Update a release rule

PATCH/products/{product_id}/access-schedules/{access_schedule_id}/rules/{release_rule_id}

Updates the type and params of a node that already has its own release rule. Other nodes are never changed.

The revision is tracked for the access schedule as a whole. Send the access schedule's current ETag value in the If-Match header to avoid overwriting a newer version.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string
access_schedule_id*string
release_rule_id*string

Header Parameters

Idempotency-Key?string

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.

If-Match?string

Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. When omitted, the update is applied to the current revision.

X-Client-Request-Id?string

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.

Lengthlength <= 64

Request 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 PATCH "https://example.com/products/string/access-schedules/string/rules/string" \  -H "Content-Type: application/json" \  -d '{    "params": {},    "type": "free"  }'
{  "data": {    "effective": {      "inherited_from": "string",      "params": [],      "type": "free"    },    "explicit": true,    "id": "string",    "level": "product",    "object": "release_rule",    "params": null,    "target_id": "string",    "type": "free"  }}

Retrieve a release rule GET

Retrieves the release rule of a single node. Release rule IDs have the format `rul_<level>_<node>`. Nodes without their own rule also return a result, with `explicit` set to `false` and `effective` containing the inherited rule.

Delete a release rule DELETE

Removes the node's own release rule so that the node inherits the rule of its parent again. At the `product` level there is no parent to inherit from, so removing the rule sets it to `free`.