Catalog Tasks
Catalog Tasks
Get task status
GET/zones/{zone_id}/catalog_tasks/{task_id}
ModelsExpand Collapse
Task = object { id, created_at, operation, 9 more }
Task = object { id, created_at, operation, 9 more }
id: string
created_at: string
formatdate-time
Accepts one of the following:
"create"
"delete"
Accepts one of the following:
"pending"
"running"
"completed"
"failed"
updated_at: string
formatdate-time
error_message: optional string
install_id: optional string
links: optional array of object { href, rel, properties, 2 more }
links: optional array of object { href, rel, properties, 2 more }
href: string
Target reference.
Fragment URIs (#name) reference other entities in the same graph by
their local name (the key in the entity map). Absolute paths and URLs reference
external resources outside the graph.
rel: string
Link relation type.
properties: optional map[unknown]
Additional metadata keyed by property name.
titles: optional map[string]
Human-readable titles keyed by BCP 47 language tag.
type: optional string
Media type of the target resource (per RFC 7033 section 4.4.4.3).
Applies to external hrefs; typically omitted for intra-graph references.
package_id: optional string
package_slug: optional string
package_version: optional number
warnings: optional array of object { code, details, message, 4 more } Informational warnings about the task outcome. For delete tasks,
warns when adopted entities (pre-existing resources not created by
the catalog) will be preserved rather than deleted.
warnings: optional array of object { code, details, message, 4 more }
Informational warnings about the task outcome. For delete tasks, warns when adopted entities (pre-existing resources not created by the catalog) will be preserved rather than deleted.
code: "validation_error" or "bad_request" or "unauthorized" or 6 more
code: "validation_error" or "bad_request" or "unauthorized" or 6 more
Accepts one of the following:
"validation_error"
"bad_request"
"unauthorized"
"forbidden"
"not_found"
"conflict"
"rate_limit_exceeded"
"internal_error"
"service_unavailable"
details: array of object { code, field, message }
details: array of object { code, field, message }
code: "validation_error" or "bad_request" or "unauthorized" or 6 more
code: "validation_error" or "bad_request" or "unauthorized" or 6 more
Accepts one of the following:
"validation_error"
"bad_request"
"unauthorized"
"forbidden"
"not_found"
"conflict"
"rate_limit_exceeded"
"internal_error"
"service_unavailable"
field: string
valid json path for request body
message: string
error message for specific error
message: string
summary of the error
path: string
formaturl
request_id: string
formatuuid
status: number
HTTP Status Code
timestamp: string
formatdate-time
TaskOperation = "create" or "delete"
TaskOperation = "create" or "delete"
Accepts one of the following:
"create"
"delete"
TaskStatus = "pending" or "running" or "completed" or "failed"
TaskStatus = "pending" or "running" or "completed" or "failed"
Accepts one of the following:
"pending"
"running"
"completed"
"failed"