Request retirement of one publication's retained configuration at the observed model generation. Exact retries return the original receipt. Current publications require revocation or model archiving first. Accepted work and pending delivery defer retirement; installation revocations and historical provenance remain permanent.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
Responses
Section titled “Responses”Request retirement of one publication’s retained configuration at the observed model generation. Exact retries return the original receipt. Current publications require revocation or model archiving first. Accepted work and pending delivery defer retirement; installation revocations and historical provenance remain permanent.
object
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Malformed request.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Valid active credential required; connector and user credentials are separate.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
The token does not permit this operation.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Resource absent or outside the caller’s authority.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Concurrent generation/publication change, conflicting retry, or a publication awaiting connector validation.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
413: the request body exceeds the configured size limit.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Request fields, manifest, installation policy, or limits are invalid.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Authentication, identity provider, or management state is temporarily unavailable.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
default
Section titled “default”An HTTP request failed; inspect the stable error code and request ID.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Documentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.