Skip to navigation
Air APIAPI ReferencePublishing

Set public vs restricted visibility

View as Markdown

Immediately sets catalog visibility for an approved published image. Send publicly_published true for global visibility, or false with allowed_orgs as the full replacement restricted allow-list (requesting org is always included; omit or [] for requesting-org-only). Must not send a non-empty allowed_orgs when publicly_published is true.

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

true makes the image globally visible; false keeps it restricted to the effective allow-list.

allowed_orgslist of stringsOptional

When publicly_published is false, full replacement allow-list as org UUIDs. The requesting org is always included in the effective list. Omit or send [] for requesting-org-only access. Must be omitted or empty when publicly_published is true.

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