Skip to navigation
Air APIAPI ReferencePublishing

Approve a publish queue entry

View as Markdown

Approve a queued publish, elevation, restriction, or allow-list request. Send publicly_published true for public visibility, or false with allowed_org for restricted visibility; when omitted, publicly_published defaults to the record’s prefer_public. PENDING_ELEVATION can only be approved as public. PENDING_UNPUBLISH takes no body and unpublishes the image.

Required scopes (any one):

  • air:admin (roles: air_admin)
  • air:sre (roles: air_sre)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequiredformat: "uuid"
A UUID string identifying this image publish access record.

Request

This endpoint expects an object.
publicly_publishedbooleanOptional

Whether to publish as public (all users) or restricted (allow-list). When omitted, defaults to the record’s prefer_public value.

allowed_orgslist of stringsOptional

Restricted allow-list as org UUIDs (same logical field as the record’s allowed_orgs relation). For PENDING, PENDING_RESTRICTION, or PENDING_ALLOWLIST, supply the list the reviewer wants (full replace for allow-list changes). The requesting org is always included automatically. [] means requesting-org-only. Must be omitted or empty when approving as public. Not used for PENDING_UNPUBLISH (empty body).

Response

idstringRead-onlyformat: "uuid"
createddatetimeRead-only
modifieddatetimeRead-only
imagestringRead-onlyformat: "uuid"
image_namestring or nullRead-only
The name of the image this record applies to.
image_versionstring or nullRead-only
The version of the image this record applies to.
requested_bystring or nullRead-only
Email of the user who submitted this record.
requesting_orgstring or nullRead-only

Return requesting org readable name (annotated on list, else relation).

requesting_org_display_namestring or nullRead-only
Requesting org display name. Same source as list search and ordering for this field.
requesting_org_ngc_org_namestring or nullRead-only
Requesting org NGC name. Same source as list search and ordering for this field.
reviewed_bystring or nullRead-only
Return the email of the reviewer.
statusenum

Current status of the publish access record.

  • PENDING - Pending
  • APPROVED - Approved
  • DENIED - Denied
  • REMOVED - Removed
  • CANCELLED - Cancelled
  • PENDING_ELEVATION - Pending Elevation
  • PENDING_RESTRICTION - Pending Restriction
  • PENDING_UNPUBLISH - Pending Unpublish
  • PENDING_ALLOWLIST - Pending Allow List Change
  • APPROVED_PENDING_IMAGE_PUBLISH - Approved Pending Image Publish
publicly_publishedbooleanRead-only

Whether the resource is published to all users (public) vs restricted to the allow-list. Set by the community manager at approval time. This is the single source of truth for public vs restricted visibility.

prefer_publicbooleanRead-only
Whether the requester prefers public publishing.
justificationstringRead-only

Optional text from the requester explaining who/why to share.

allowed_orgs_request_textstringRead-only

Free-text hint from the requester describing which orgs should have access for restricted publishing. Not the authoritative allow list.

denial_reasonstringRead-only
Reason provided by community manager when denying this record.
requested_atdatetime or nullRead-only
When the current request was submitted. Cleared when the requester cancels without a review.
reviewed_atdatetime or nullRead-only

When a community manager or privileged actor last reviewed the current or most recent request (approve, deny, or immediate visibility change).

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error