Skip to main content

Common types

Error

FieldTypeRequiredNotes
reasonBadRequest | NotFound | TooLarge | Unauthorized | Forbidden | Conflict | Internal | UnavailableYesMachine-readable category
messagestringYesHuman-readable explanation

The following table maps HTTP codes to their respective reason:

HTTP codeReason
400 Bad RequestBadRequest
401 UnauthorizedUnauthorized
403 ForbiddenForbidden
404 Not FoundNotFound
409 ConflictConflict
413 Entity Too LargeTooLarge
500 Internal Server ErrorInternal
503 Service UnavailableUnavailable

ObjectMeta

FieldTypeRequiredNotes
namestringYesObject name
workspacestringYesOwning workspace
namePrefixstringUsed only on create to auto-generate name
revintRevision for optimistic concurrency
createdAtstring (RFC 3339)Creation timestamp
updatedAtstring (RFC 3339)Last-update timestamp
ownerIDstringUser ID that created the object

ListMeta

cursor - optional string

FieldTypeRequiredNotes
cursorstringOpaque cursor token for the next page

ListOptions

FieldTypeRequiredNotes
limitintSoft page-size cap; server may return fewer
cursorstringCursor from a previous list response
selectorstringSelector expression (see filtering)

LocalObjectReference

FieldTypeRequiredNotes
namestringName of the referenced object within the same workspace