Skip to navigation
Air APIAPI ReferenceImages

Create an image share

View as Markdown

Create a new image share instance for an image in your organization that another organization can claim. The id returned will be used as the unique “claim code” which should be securely given to the target organization representative and be used as the image_share value when claiming an image share.

Requirements:

  • The image must be owned by your organization
  • The image must have COMPLETE upload status
  • The target organization must be different from your organization

Expiration: Shares expire after a configured TTL (by default 24 hours) and are automatically cleaned up by background tasks.

Required scope: air:image_sharing (roles: air_image_sharer)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
imagestringRequiredformat: "uuid"

The id of the image to share. This must be unpublished image owned by your organization.

target_orgstringRequired>=1 character
The NGC org name of the organization receiving the image.
expires_atdatetimeOptional
The date and time the image share expires. This must be in the future and defaults to 24 hours after creation.

Response

idstringRead-onlyformat: "uuid"

The primary key of the image share. This is the “claim code” which should be given to the target organization representative and be used as the image_share value when claiming an image share.

createddatetimeRead-only
modifieddatetimeRead-only
imagestringformat: "uuid"

The id of the image to share. This must be unpublished image owned by your organization.

image_namestringRead-only

The name of the image to share.

image_versionstringRead-only

The version of the image to share.

source_org_display_namestringRead-only
The name of the organization sharing the image.
target_org_display_namestringRead-only
The name of the organization receiving the image.
target_orgstring
The NGC org name of the organization receiving the image.
claimed_bystringRead-onlyDefaults to
The email of the user who claimed the image share.
statestringRead-onlyDefaults to ACTIVE

A state associated with the image share. Only ACTIVE image shares may be claimed.

expires_atdatetimeOptional
The date and time the image share expires. This must be in the future and defaults to 24 hours after creation.

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error