Orishare
API reference

List change sets

GET
/change_sets

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
Default50
cursor?string
Lengthlength <= 2048
status?string

Value in

  • "pending"
  • "committed"
  • "stale"
  • "expired"
  • "cancelled"
source?string

Value in

  • "manual"
  • "playbook"
  • "bulk"
  • "upgrade"
  • "assistant"
authority?string

Only committed change sets whose commit had this authority: policy lists what was applied without a dashboard confirmation (the agent activity log).

Value in

  • "confirmation"
  • "policy"

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/change_sets"
{  "data": [    {      "id": "string",      "environment_id": "string",      "status": "pending",      "channel": "dashboard",      "source": "manual",      "principal": {        "kind": "string",        "id": "string"      },      "commands": [        null      ],      "plan": {        "plan_digest": "string",        "commands_digest": "string",        "snapshot_at": "string",        "diff": {          "entries": [            null          ],          "unchanged": -9007199254740991        },        "expected_versions": [          {            "resource": "string",            "key": "string",            "version": "string"          }        ],        "effects": {          "property1": null,          "property2": null        },        "irreversibility": [          null        ],        "flags": [          {            "kind": "trust_weakening",            "resource": "event_definition",            "key": "string",            "change": {              "path": "string",              "before": null,              "after": null            },            "digest": "string"          }        ],        "required_scopes": [          "string"        ],        "approved_bounds": {          "liability": [            {              "currency": "string",              "max_minor": "string"            }          ],          "stock": [            {              "offer": "string",              "max_units": "string"            }          ],          "codes": [            {              "pool": "string",              "max_codes": "string"            }          ],          "customers_affected": "string",          "issuances": {            "property1": "string",            "property2": "string"          }        },        "bulk": {          "bulk_operation_id": "string",          "kind": "string",          "parameters": {            "property1": null,            "property2": null          },          "selection": {            "property1": null,            "property2": null          },          "undo_of": "string",          "item_count": -9007199254740991,          "counts": {            "pending": -9007199254740991,            "skipped": -9007199254740991          },          "skip_reasons": {            "property1": -9007199254740991,            "property2": -9007199254740991          },          "undo_class": "string",          "undo_classes": {            "property1": -9007199254740991,            "property2": -9007199254740991          },          "notes": [            "string"          ],          "sample": [            {              "property1": null,              "property2": null            }          ]        },        "playbook": {          "property1": null,          "property2": null        },        "destructive": [          {            "kind": "string",            "count": 0,            "identities": [              "string"            ],            "digest": "string"          }        ],        "provenance": {          "source_environment_id": "string",          "source_configuration_revision": "string"        },        "dependencies": [          {            "kind": "program",            "key": "string",            "id": "string",            "version_id": "string"          }        ],        "undo_of": "string",        "preconditions": {          "property1": null,          "property2": null        }      },      "publish": true,      "expires_at": "string",      "stale_reason": null,      "committed_at": "string",      "commit_id": "string",      "commit": {        "id": "string",        "authority": "confirmation",        "principal": {          "kind": "string",          "id": "string"        },        "policy": {          "property1": null,          "property2": null        },        "committed_at": "string"      },      "undo_of": "string",      "undone_by": "string",      "created_at": "string",      "updated_at": "string",      "version": -9007199254740991    }  ],  "next_cursor": "string",  "has_more": true}

Propose a change set: plan it without applying and store the plan for review

POST
/change_sets

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

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

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/change_sets" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "commands": [      {        "type": "portal_configuration.publish",        "key": "rewards",        "expected_revision": 3      }    ]  }'
{  "id": "string",  "environment_id": "string",  "status": "pending",  "channel": "dashboard",  "source": "manual",  "principal": {    "kind": "string",    "id": "string"  },  "commands": [    null  ],  "plan": {    "plan_digest": "string",    "commands_digest": "string",    "snapshot_at": "string",    "diff": {      "entries": [        null      ],      "unchanged": -9007199254740991    },    "expected_versions": [      {        "resource": "string",        "key": "string",        "version": "string"      }    ],    "effects": {      "property1": null,      "property2": null    },    "irreversibility": [      null    ],    "flags": [      {        "kind": "trust_weakening",        "resource": "event_definition",        "key": "string",        "change": {          "path": "string",          "before": null,          "after": null        },        "digest": "string"      }    ],    "required_scopes": [      "string"    ],    "approved_bounds": {      "liability": [        {          "currency": "string",          "max_minor": "string"        }      ],      "stock": [        {          "offer": "string",          "max_units": "string"        }      ],      "codes": [        {          "pool": "string",          "max_codes": "string"        }      ],      "customers_affected": "string",      "issuances": {        "property1": "string",        "property2": "string"      }    },    "bulk": {      "bulk_operation_id": "string",      "kind": "string",      "parameters": {        "property1": null,        "property2": null      },      "selection": {        "property1": null,        "property2": null      },      "undo_of": "string",      "item_count": -9007199254740991,      "counts": {        "pending": -9007199254740991,        "skipped": -9007199254740991      },      "skip_reasons": {        "property1": -9007199254740991,        "property2": -9007199254740991      },      "undo_class": "string",      "undo_classes": {        "property1": -9007199254740991,        "property2": -9007199254740991      },      "notes": [        "string"      ],      "sample": [        {          "property1": null,          "property2": null        }      ]    },    "playbook": {      "property1": null,      "property2": null    },    "destructive": [      {        "kind": "string",        "count": 0,        "identities": [          "string"        ],        "digest": "string"      }    ],    "provenance": {      "source_environment_id": "string",      "source_configuration_revision": "string"    },    "dependencies": [      {        "kind": "program",        "key": "string",        "id": "string",        "version_id": "string"      }    ],    "undo_of": "string",    "preconditions": {      "property1": null,      "property2": null    }  },  "publish": true,  "expires_at": "string",  "stale_reason": null,  "committed_at": "string",  "commit_id": "string",  "commit": {    "id": "string",    "authority": "confirmation",    "principal": {      "kind": "string",      "id": "string"    },    "policy": {      "property1": null,      "property2": null    },    "committed_at": "string"  },  "undo_of": "string",  "undone_by": "string",  "created_at": "string",  "updated_at": "string",  "version": -9007199254740991}

Read a change set with its stored plan

GET
/change_sets/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Query Parameters

include_advisories?string

true: commit.policy keeps the advisories its limits evaluation recorded (never blocking: trust_weakening, client_uncapped, withholds_rewards). Left out by default. Applications and undos never carry them (their responses are stored and replayed whatever the query).

Value in

  • "true"
  • "false"

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/change_sets/string"
{  "id": "string",  "environment_id": "string",  "status": "pending",  "channel": "dashboard",  "source": "manual",  "principal": {    "kind": "string",    "id": "string"  },  "commands": [    null  ],  "plan": {    "plan_digest": "string",    "commands_digest": "string",    "snapshot_at": "string",    "diff": {      "entries": [        null      ],      "unchanged": -9007199254740991    },    "expected_versions": [      {        "resource": "string",        "key": "string",        "version": "string"      }    ],    "effects": {      "property1": null,      "property2": null    },    "irreversibility": [      null    ],    "flags": [      {        "kind": "trust_weakening",        "resource": "event_definition",        "key": "string",        "change": {          "path": "string",          "before": null,          "after": null        },        "digest": "string"      }    ],    "required_scopes": [      "string"    ],    "approved_bounds": {      "liability": [        {          "currency": "string",          "max_minor": "string"        }      ],      "stock": [        {          "offer": "string",          "max_units": "string"        }      ],      "codes": [        {          "pool": "string",          "max_codes": "string"        }      ],      "customers_affected": "string",      "issuances": {        "property1": "string",        "property2": "string"      }    },    "bulk": {      "bulk_operation_id": "string",      "kind": "string",      "parameters": {        "property1": null,        "property2": null      },      "selection": {        "property1": null,        "property2": null      },      "undo_of": "string",      "item_count": -9007199254740991,      "counts": {        "pending": -9007199254740991,        "skipped": -9007199254740991      },      "skip_reasons": {        "property1": -9007199254740991,        "property2": -9007199254740991      },      "undo_class": "string",      "undo_classes": {        "property1": -9007199254740991,        "property2": -9007199254740991      },      "notes": [        "string"      ],      "sample": [        {          "property1": null,          "property2": null        }      ]    },    "playbook": {      "property1": null,      "property2": null    },    "destructive": [      {        "kind": "string",        "count": 0,        "identities": [          "string"        ],        "digest": "string"      }    ],    "provenance": {      "source_environment_id": "string",      "source_configuration_revision": "string"    },    "dependencies": [      {        "kind": "program",        "key": "string",        "id": "string",        "version_id": "string"      }    ],    "undo_of": "string",    "preconditions": {      "property1": null,      "property2": null    }  },  "publish": true,  "expires_at": "string",  "stale_reason": null,  "committed_at": "string",  "commit_id": "string",  "commit": {    "id": "string",    "authority": "confirmation",    "principal": {      "kind": "string",      "id": "string"    },    "policy": {      "property1": null,      "property2": null    },    "committed_at": "string"  },  "undo_of": "string",  "undone_by": "string",  "created_at": "string",  "updated_at": "string",  "version": -9007199254740991,  "confirmation": {    "csrf_token": "string"  }}

Commit a reviewed change set (signed-in dashboard confirmation only)

POST
/change_set_commits

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

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

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/change_set_commits" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "change_set_id": "chs_00000000000000000000000000000001",    "plan_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"  }'
{  "id": "string",  "change_set_id": "string",  "status": "committed",  "plan_digest": "string",  "acknowledged_flags": [    "string"  ],  "outcome": {    "property1": null,    "property2": null  },  "change_set": {    "id": "string",    "environment_id": "string",    "status": "pending",    "channel": "dashboard",    "source": "manual",    "principal": {      "kind": "string",      "id": "string"    },    "commands": [      null    ],    "plan": {      "plan_digest": "string",      "commands_digest": "string",      "snapshot_at": "string",      "diff": {        "entries": [          null        ],        "unchanged": -9007199254740991      },      "expected_versions": [        {          "resource": "string",          "key": "string",          "version": "string"        }      ],      "effects": {        "property1": null,        "property2": null      },      "irreversibility": [        null      ],      "flags": [        {          "kind": "trust_weakening",          "resource": "event_definition",          "key": "string",          "change": {            "path": "string",            "before": null,            "after": null          },          "digest": "string"        }      ],      "required_scopes": [        "string"      ],      "approved_bounds": {        "liability": [          {            "currency": "string",            "max_minor": "string"          }        ],        "stock": [          {            "offer": "string",            "max_units": "string"          }        ],        "codes": [          {            "pool": "string",            "max_codes": "string"          }        ],        "customers_affected": "string",        "issuances": {          "property1": "string",          "property2": "string"        }      },      "bulk": {        "bulk_operation_id": "string",        "kind": "string",        "parameters": {          "property1": null,          "property2": null        },        "selection": {          "property1": null,          "property2": null        },        "undo_of": "string",        "item_count": -9007199254740991,        "counts": {          "pending": -9007199254740991,          "skipped": -9007199254740991        },        "skip_reasons": {          "property1": -9007199254740991,          "property2": -9007199254740991        },        "undo_class": "string",        "undo_classes": {          "property1": -9007199254740991,          "property2": -9007199254740991        },        "notes": [          "string"        ],        "sample": [          {            "property1": null,            "property2": null          }        ]      },      "playbook": {        "property1": null,        "property2": null      },      "destructive": [        {          "kind": "string",          "count": 0,          "identities": [            "string"          ],          "digest": "string"        }      ],      "provenance": {        "source_environment_id": "string",        "source_configuration_revision": "string"      },      "dependencies": [        {          "kind": "program",          "key": "string",          "id": "string",          "version_id": "string"        }      ],      "undo_of": "string",      "preconditions": {        "property1": null,        "property2": null      }    },    "publish": true,    "expires_at": "string",    "stale_reason": null,    "committed_at": "string",    "commit_id": "string",    "commit": {      "id": "string",      "authority": "confirmation",      "principal": {        "kind": "string",        "id": "string"      },      "policy": {        "property1": null,        "property2": null      },      "committed_at": "string"    },    "undo_of": "string",    "undone_by": "string",    "created_at": "string",    "updated_at": "string",    "version": -9007199254740991  }}

Apply a proposed change set under the environment autonomy policy, without a dashboard confirmation: always in a sandbox; in production when GET /autonomy_policy says auto, or limits and the plan is inside them. A policy refusal is confirmation_required with details.reasons and details.review_url, and the change set stays pending for a person

POST
/change_set_applications

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

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

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/change_set_applications" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "change_set_id": "chs_00000000000000000000000000000001",    "plan_digest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"  }'
{  "id": "string",  "change_set_id": "string",  "status": "committed",  "plan_digest": "string",  "acknowledged_flags": [    "string"  ],  "outcome": {    "property1": null,    "property2": null  },  "change_set": {    "id": "string",    "environment_id": "string",    "status": "pending",    "channel": "dashboard",    "source": "manual",    "principal": {      "kind": "string",      "id": "string"    },    "commands": [      null    ],    "plan": {      "plan_digest": "string",      "commands_digest": "string",      "snapshot_at": "string",      "diff": {        "entries": [          null        ],        "unchanged": -9007199254740991      },      "expected_versions": [        {          "resource": "string",          "key": "string",          "version": "string"        }      ],      "effects": {        "property1": null,        "property2": null      },      "irreversibility": [        null      ],      "flags": [        {          "kind": "trust_weakening",          "resource": "event_definition",          "key": "string",          "change": {            "path": "string",            "before": null,            "after": null          },          "digest": "string"        }      ],      "required_scopes": [        "string"      ],      "approved_bounds": {        "liability": [          {            "currency": "string",            "max_minor": "string"          }        ],        "stock": [          {            "offer": "string",            "max_units": "string"          }        ],        "codes": [          {            "pool": "string",            "max_codes": "string"          }        ],        "customers_affected": "string",        "issuances": {          "property1": "string",          "property2": "string"        }      },      "bulk": {        "bulk_operation_id": "string",        "kind": "string",        "parameters": {          "property1": null,          "property2": null        },        "selection": {          "property1": null,          "property2": null        },        "undo_of": "string",        "item_count": -9007199254740991,        "counts": {          "pending": -9007199254740991,          "skipped": -9007199254740991        },        "skip_reasons": {          "property1": -9007199254740991,          "property2": -9007199254740991        },        "undo_class": "string",        "undo_classes": {          "property1": -9007199254740991,          "property2": -9007199254740991        },        "notes": [          "string"        ],        "sample": [          {            "property1": null,            "property2": null          }        ]      },      "playbook": {        "property1": null,        "property2": null      },      "destructive": [        {          "kind": "string",          "count": 0,          "identities": [            "string"          ],          "digest": "string"        }      ],      "provenance": {        "source_environment_id": "string",        "source_configuration_revision": "string"      },      "dependencies": [        {          "kind": "program",          "key": "string",          "id": "string",          "version_id": "string"        }      ],      "undo_of": "string",      "preconditions": {        "property1": null,        "property2": null      }    },    "publish": true,    "expires_at": "string",    "stale_reason": null,    "committed_at": "string",    "commit_id": "string",    "commit": {      "id": "string",      "authority": "confirmation",      "principal": {        "kind": "string",        "id": "string"      },      "policy": {        "property1": null,        "property2": null      },      "committed_at": "string"    },    "undo_of": "string",    "undone_by": "string",    "created_at": "string",    "updated_at": "string",    "version": -9007199254740991  },  "authority": "policy"}

Undo a committed change set: propose a change set that restores what it changed (what it created is archived or deactivated, never deleted) and apply it under the autonomy policy when the policy allows; otherwise application is null and the undo waits for a dashboard confirmation. invalid_state when it has no undo: not committed, already undone, bulk or playbook (their own undo), an operation command, an irreversible change, a deletion or creation the configuration document cannot reverse, or an item changed again since

POST
/change_set_undos

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

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

application/json

application/json

application/json

curl -X POST "https://example.com/change_set_undos" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "change_set_id": "chs_00000000000000000000000000000001"  }'
{  "change_set": {    "id": "string",    "environment_id": "string",    "status": "pending",    "channel": "dashboard",    "source": "manual",    "principal": {      "kind": "string",      "id": "string"    },    "commands": [      null    ],    "plan": {      "plan_digest": "string",      "commands_digest": "string",      "snapshot_at": "string",      "diff": {        "entries": [          null        ],        "unchanged": -9007199254740991      },      "expected_versions": [        {          "resource": "string",          "key": "string",          "version": "string"        }      ],      "effects": {        "property1": null,        "property2": null      },      "irreversibility": [        null      ],      "flags": [        {          "kind": "trust_weakening",          "resource": "event_definition",          "key": "string",          "change": {            "path": "string",            "before": null,            "after": null          },          "digest": "string"        }      ],      "required_scopes": [        "string"      ],      "approved_bounds": {        "liability": [          {            "currency": "string",            "max_minor": "string"          }        ],        "stock": [          {            "offer": "string",            "max_units": "string"          }        ],        "codes": [          {            "pool": "string",            "max_codes": "string"          }        ],        "customers_affected": "string",        "issuances": {          "property1": "string",          "property2": "string"        }      },      "bulk": {        "bulk_operation_id": "string",        "kind": "string",        "parameters": {          "property1": null,          "property2": null        },        "selection": {          "property1": null,          "property2": null        },        "undo_of": "string",        "item_count": -9007199254740991,        "counts": {          "pending": -9007199254740991,          "skipped": -9007199254740991        },        "skip_reasons": {          "property1": -9007199254740991,          "property2": -9007199254740991        },        "undo_class": "string",        "undo_classes": {          "property1": -9007199254740991,          "property2": -9007199254740991        },        "notes": [          "string"        ],        "sample": [          {            "property1": null,            "property2": null          }        ]      },      "playbook": {        "property1": null,        "property2": null      },      "destructive": [        {          "kind": "string",          "count": 0,          "identities": [            "string"          ],          "digest": "string"        }      ],      "provenance": {        "source_environment_id": "string",        "source_configuration_revision": "string"      },      "dependencies": [        {          "kind": "program",          "key": "string",          "id": "string",          "version_id": "string"        }      ],      "undo_of": "string",      "preconditions": {        "property1": null,        "property2": null      }    },    "publish": true,    "expires_at": "string",    "stale_reason": null,    "committed_at": "string",    "commit_id": "string",    "commit": {      "id": "string",      "authority": "confirmation",      "principal": {        "kind": "string",        "id": "string"      },      "policy": {        "property1": null,        "property2": null      },      "committed_at": "string"    },    "undo_of": "string",    "undone_by": "string",    "created_at": "string",    "updated_at": "string",    "version": -9007199254740991  },  "application": {    "id": "string",    "change_set_id": "string",    "status": "committed",    "plan_digest": "string",    "acknowledged_flags": [      "string"    ],    "outcome": {      "property1": null,      "property2": null    },    "change_set": {      "id": "string",      "environment_id": "string",      "status": "pending",      "channel": "dashboard",      "source": "manual",      "principal": {        "kind": "string",        "id": "string"      },      "commands": [        null      ],      "plan": {        "plan_digest": "string",        "commands_digest": "string",        "snapshot_at": "string",        "diff": {          "entries": [            null          ],          "unchanged": -9007199254740991        },        "expected_versions": [          {            "resource": "string",            "key": "string",            "version": "string"          }        ],        "effects": {          "property1": null,          "property2": null        },        "irreversibility": [          null        ],        "flags": [          {            "kind": "trust_weakening",            "resource": "event_definition",            "key": "string",            "change": {              "path": "string",              "before": null,              "after": null            },            "digest": "string"          }        ],        "required_scopes": [          "string"        ],        "approved_bounds": {          "liability": [            {              "currency": "string",              "max_minor": "string"            }          ],          "stock": [            {              "offer": "string",              "max_units": "string"            }          ],          "codes": [            {              "pool": "string",              "max_codes": "string"            }          ],          "customers_affected": "string",          "issuances": {            "property1": "string",            "property2": "string"          }        },        "bulk": {          "bulk_operation_id": "string",          "kind": "string",          "parameters": {            "property1": null,            "property2": null          },          "selection": {            "property1": null,            "property2": null          },          "undo_of": "string",          "item_count": -9007199254740991,          "counts": {            "pending": -9007199254740991,            "skipped": -9007199254740991          },          "skip_reasons": {            "property1": -9007199254740991,            "property2": -9007199254740991          },          "undo_class": "string",          "undo_classes": {            "property1": -9007199254740991,            "property2": -9007199254740991          },          "notes": [            "string"          ],          "sample": [            {              "property1": null,              "property2": null            }          ]        },        "playbook": {          "property1": null,          "property2": null        },        "destructive": [          {            "kind": "string",            "count": 0,            "identities": [              "string"            ],            "digest": "string"          }        ],        "provenance": {          "source_environment_id": "string",          "source_configuration_revision": "string"        },        "dependencies": [          {            "kind": "program",            "key": "string",            "id": "string",            "version_id": "string"          }        ],        "undo_of": "string",        "preconditions": {          "property1": null,          "property2": null        }      },      "publish": true,      "expires_at": "string",      "stale_reason": null,      "committed_at": "string",      "commit_id": "string",      "commit": {        "id": "string",        "authority": "confirmation",        "principal": {          "kind": "string",          "id": "string"        },        "policy": {          "property1": null,          "property2": null        },        "committed_at": "string"      },      "undo_of": "string",      "undone_by": "string",      "created_at": "string",      "updated_at": "string",      "version": -9007199254740991    },    "authority": "policy"  },  "residuals": [    {      "kind": "currency_kept",      "detail": "string"    }  ]}

Cancel a pending change set

POST
/change_sets/{id}/cancellations

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/change_sets/string/cancellations" \  -H "Idempotency-Key: string"
{  "id": "string",  "environment_id": "string",  "status": "pending",  "channel": "dashboard",  "source": "manual",  "principal": {    "kind": "string",    "id": "string"  },  "commands": [    null  ],  "plan": {    "plan_digest": "string",    "commands_digest": "string",    "snapshot_at": "string",    "diff": {      "entries": [        null      ],      "unchanged": -9007199254740991    },    "expected_versions": [      {        "resource": "string",        "key": "string",        "version": "string"      }    ],    "effects": {      "property1": null,      "property2": null    },    "irreversibility": [      null    ],    "flags": [      {        "kind": "trust_weakening",        "resource": "event_definition",        "key": "string",        "change": {          "path": "string",          "before": null,          "after": null        },        "digest": "string"      }    ],    "required_scopes": [      "string"    ],    "approved_bounds": {      "liability": [        {          "currency": "string",          "max_minor": "string"        }      ],      "stock": [        {          "offer": "string",          "max_units": "string"        }      ],      "codes": [        {          "pool": "string",          "max_codes": "string"        }      ],      "customers_affected": "string",      "issuances": {        "property1": "string",        "property2": "string"      }    },    "bulk": {      "bulk_operation_id": "string",      "kind": "string",      "parameters": {        "property1": null,        "property2": null      },      "selection": {        "property1": null,        "property2": null      },      "undo_of": "string",      "item_count": -9007199254740991,      "counts": {        "pending": -9007199254740991,        "skipped": -9007199254740991      },      "skip_reasons": {        "property1": -9007199254740991,        "property2": -9007199254740991      },      "undo_class": "string",      "undo_classes": {        "property1": -9007199254740991,        "property2": -9007199254740991      },      "notes": [        "string"      ],      "sample": [        {          "property1": null,          "property2": null        }      ]    },    "playbook": {      "property1": null,      "property2": null    },    "destructive": [      {        "kind": "string",        "count": 0,        "identities": [          "string"        ],        "digest": "string"      }    ],    "provenance": {      "source_environment_id": "string",      "source_configuration_revision": "string"    },    "dependencies": [      {        "kind": "program",        "key": "string",        "id": "string",        "version_id": "string"      }    ],    "undo_of": "string",    "preconditions": {      "property1": null,      "property2": null    }  },  "publish": true,  "expires_at": "string",  "stale_reason": null,  "committed_at": "string",  "commit_id": "string",  "commit": {    "id": "string",    "authority": "confirmation",    "principal": {      "kind": "string",      "id": "string"    },    "policy": {      "property1": null,      "property2": null    },    "committed_at": "string"  },  "undo_of": "string",  "undone_by": "string",  "created_at": "string",  "updated_at": "string",  "version": -9007199254740991}

Challenges

Challenges, enrollment and progress.

Client configurations

Exact browser origins and bounded client admission settings.