openapi: 3.2.0 info: contact: email: support@linode.com name: Linode url: https://linode.com description: Add a Cloud Computing instance so you can build, release, and scale applications faster with virtual machines. license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: 'Akamai: Linode Image sharing API' version: 4.215.0 servers: - url: https://api.linode.com tags: - name: Image sharing paths: /{apiVersion}/images/sharegroups: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml x-akamai: file-path: paths/images-sharegroups.yaml path-info: /{apiVersion}/images/sharegroups status: BETA x-linode-cli-command: image-sharegroups post: description: 'Creates a group to share images with other users. - Include existing `images` in the request or Add images to a share group later. Run the Get an image operation to see the existing images'' `id` values. If needed, Create an image or Upload an image. - You can set a `label` and `description` for the group and each image, visible to all group members. - If omitted, the shared image keeps the original `label` and `description`. Note that when you Update the original image, it has no effect on shared image''s details within any groups. - Run the Add members to a share group to include other users in the group. Use the group''s `uuid` from the response to Create a token for user authentication. > --- - __CLI__. ``` linode-cli image-sharegroups create --label "my_label" --description "my_description" \ --images ''[{"id": "private/15", "label": "Linux Debian", "description": "Official Debian Linux image for server deployment"}]'' ``` Learn more... - __OAuth scopes__. ``` images:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/post-sharegroups operationId: post-sharegroups requestBody: content: application/json: schema: additionalProperties: false properties: description: description: A detailed description of this share group. example: '{{description}}' type: string images: description: A list of image's details, including the ID, label, and description. items: additionalProperties: false properties: description: description: The image's description within the share group. example: Official Debian Linux image for server deployment type: string id: description: The private image’s unique slug identifier. example: private/7 type: string label: description: The image's name within the share group. example: Linux Debian type: string required: - id type: object type: array label: description: The share group's descriptive name. example: '{{label}}' type: string required: - label type: object x-akamai: file-path: schemas/post-sharegroup.yaml x-example: x-ref: ../examples/post-sharegroup.json responses: '200': content: application/json: schema: additionalProperties: false description: The share group's details. properties: created: description: __Read-only__ When this share group was created. example: '2025-04-14T22:44:02' format: date-time readOnly: true type: string description: description: A detailed description of this share group. example: Group of base operating system images and engineers used for CI/CD pipelines and infrastructure automation type: - string - 'null' x-linode-cli-display: 4 expiry: description: __Read-only__ When the share group expires. example: null format: date-time readOnly: true type: - string - 'null' id: description: __Read-only__ The share group's numeric identifier, used primarily as path parameters in URLs. example: 1 readOnly: true type: integer x-linode-cli-display: 1 images_count: description: __Read-only__ The total number of images currently belonging to the share group. readOnly: true type: integer x-linode-cli-display: 6 is_suspended: description: __Read-only__ If `true`, the share group is currently suspended. example: false readOnly: true type: boolean x-linode-cli-display: 5 label: description: The share group's descriptive name. example: DevOps Base Images type: string x-linode-cli-display: 2 members_count: description: __Read-only__ The number of users with access to the share group. readOnly: true type: integer x-linode-cli-display: 7 updated: description: __Read-only__ When this share group was last updated. example: null format: date-time readOnly: true type: - string - 'null' uuid: description: __Read-only__ The share group's unique identifier used for membership token management. example: 1533863e-16a4-47b5-b829-ac0f35c13278 format: uuid readOnly: true type: string x-linode-cli-display: 3 required: - id - uuid - label - description - is_suspended - created - updated - expiry - images_count - members_count type: object x-akamai: file-path: schemas/sharegroup.yaml x-example: x-ref: ../examples/post-sharegroup-200.json description: New share group created successfully. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_write summary: Create a share group tags: - Image sharing x-akamai: tabs: - syntax: "linode-cli image-sharegroups create --label \"my_label\" --description \"my_description\" \\\n --images '[{\"id\": \"private/15\", \"label\": \"Linux Debian\", \"description\": \"Official Debian Linux image for server deployment\"}]'" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: create get: description: 'Lists all owned groups with shared images. > 📘 > > This operation doesn''t list groups you''re a member of. Run Get a token''s share group to find these share groups using your membership token. > --- - __CLI__. ``` linode-cli image-sharegroups list ``` Learn more... - __OAuth scopes__. ``` images:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-sharegroups operationId: get-sharegroups parameters: - description: The page of a collection to return. example: '{{page}}' in: query name: page required: false schema: default: 1 example: 6 minimum: 1 type: integer x-akamai: file-path: parameters/page-offset.yaml - description: The number of items to return per page. example: '{{page_size}}' in: query name: page_size schema: default: 100 example: 50 maximum: 500 minimum: 25 type: integer x-akamai: file-path: parameters/page-size.yaml responses: '200': content: application/json: schema: additionalProperties: false properties: data: items: additionalProperties: false description: The share group's details. properties: created: description: __Read-only__ When this share group was created. example: '2025-04-14T22:44:02' format: date-time readOnly: true type: string description: description: The share group's detailed description. example: Group of base operating system images and engineers used for CI/CD pipelines and infrastructure automation type: - string - 'null' x-linode-cli-display: 4 expiry: description: __Read-only__ When the share group expires. example: null format: date-time readOnly: true type: - string - 'null' id: description: The share group's numeric identifier, used primarily as path parameters in URLs. example: 1 type: integer x-linode-cli-display: 1 images_count: description: __Read-only__ The total number of images currently belonging to the share group. readOnly: true type: integer x-linode-cli-display: 6 is_suspended: description: __Read-only__ Indicates whether the share group is currently suspended. example: false readOnly: true type: boolean x-linode-cli-display: 5 label: description: __Filterable__ The share group's descriptive name. example: DevOps Base Images type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true members_count: description: __Read-only__ The number of users with access to the share group. readOnly: true type: integer x-linode-cli-display: 7 updated: description: __Read-only__ When this share group was last updated. example: null format: date-time readOnly: true type: - string - 'null' uuid: description: The share group's unique identifier used for membership token management. example: 1533863e-16a4-47b5-b829-ac0f35c13278 format: uuid type: string x-linode-cli-display: 3 required: - id - uuid - label - description - is_suspended - created - updated - expiry - images_count - members_count type: object x-akamai: file-path: schemas/sharegroups.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer required: - data - page - pages - results type: object x-akamai: file-path: schemas/get-sharegroups-200.yaml x-example: x-ref: ../examples/post-sharegroup-images-200.json description: A paginated list of sharegroups. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_only summary: List share groups tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups list title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: - list - ls x-linode-redoc-load-ids: true /{apiVersion}/images/sharegroups/tokens: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml x-akamai: file-path: paths/images-sharegroup-tokens.yaml path-info: /{apiVersion}/images/sharegroups/tokens status: BETA x-linode-cli-command: image-sharegroups post: description: 'Creates a single-use membership token for users who want to join a share group with custom images. - Before creating a token, get the share group''s UUID from its owner. The owner can run List share groups or Get a share group to get the group''s UUID. If needed, Create a share group and share the UUID with the user. - Share the `token` from the response with the share group owner. The owner can later use the token to Add members to a share group and manage the users'' membership within the group. > --- - __CLI__. ``` linode-cli image-sharegroups token-create --label "my_token" --valid_for_sharegroup_uuid "abc123" ``` Learn more... - __OAuth scopes__. ``` images:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/post-sharegroup-tokens operationId: post-sharegroup-tokens requestBody: content: application/json: schema: additionalProperties: false properties: label: description: The token's descriptive name. example: '{{label}}' type: string valid_for_sharegroup_uuid: description: The unique identifier of the share group you want to create a token for. example: '{{valid_for_sharegroup_uuid}}' type: string required: - valid_for_sharegroup_uuid type: object x-akamai: file-path: schemas/post-sharegroup-token.yaml x-example: x-ref: ../examples/post-sharegroup-tokens.json responses: '200': content: application/json: schema: additionalProperties: false description: The share group membership token's details. properties: created: description: __Read-only__ When the token was created. example: '2025-08-04T10:09:09' format: date-time readOnly: true type: string expiry: description: __Read-only__ When this token expires. example: null format: date-time readOnly: true type: - string - 'null' label: description: The token's descriptive name. example: Backend Services - Engineering type: - string - 'null' x-linode-cli-display: 2 sharegroup_label: description: __Read-only__ The share group's descriptive name. example: DevOps Base Images readOnly: true type: string x-linode-cli-display: 6 sharegroup_uuid: description: __Read-only__ The share group's unique identifier. example: e1d0e58b-f89f-4237-84ab-b82077342359 readOnly: true type: string x-linode-cli-display: 5 status: description: '__Read-only__ The membership token''s status: - `pending`: The token has been created but is not yet active. - `active`: The token is currently active and usable. - `revoked`: The token has been deleted and is no longer valid. - `expired`: The token has passed its validity period and is no longer usable.' enum: - pending - active - revoked - expired example: active readOnly: true type: string x-linode-cli-display: 3 token: description: '__Read-only__ The single-use JWT membership token encoded as a string. It consists of three parts: header, payload, and signature. Shared image groups owners can use it to [Add members to a share group](https://techdocs.akamai.com/linode-api/reference/post-sharegroup-members).' example: eyJhbGciOiJIUzI1 ... VNKDTt2yEiJVGSos readOnly: true type: string x-linode-cli-display: 7 token_uuid: description: __Read-only__ The membership token's unique identifier. example: 13428362-5458-4dad-b14b-8d0d4d648f8c readOnly: true type: string x-linode-cli-display: 1 updated: description: __Read-only__ When the token was last updated. example: null format: date-time readOnly: true type: - string - 'null' valid_for_sharegroup_uuid: description: __Read-only__ The unique identifier of the share group you created a token for. example: e1d0e58b-f89f-4237-84ab-b82077342359 readOnly: true type: string x-linode-cli-display: 4 required: - token - token_uuid - status - label - created - updated - expiry - valid_for_sharegroup_uuid - sharegroup_uuid - sharegroup_label type: object x-akamai: file-path: schemas/post-sharegroup-token-200.yaml x-example: x-ref: ../examples/post-sharegroup-tokens-200.json description: Token generated successfully. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_write summary: Create a token tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups token-create --label "my_token" --valid_for_sharegroup_uuid "abc123" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: token-create x-linode-redoc-load-ids: true get: description: 'Get details about all the user''s tokens. > --- - __CLI__. ``` linode-cli image-sharegroups tokens-list ``` Learn more... - __OAuth scopes__. ``` images:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-user-tokens operationId: get-user-tokens responses: '200': content: application/json: schema: additionalProperties: false properties: data: items: additionalProperties: false description: ImageShareGroupMemberTokens object. properties: created: description: __Read-only__ The creation time of this token. example: '2025-08-04T10:09:09' format: date-time readOnly: true type: string expiry: description: __Read-only__ The time when this token expires. example: null format: date-time readOnly: true type: - string - 'null' label: description: __Filterable__ A short description of the token. example: Backend Services - Engineering type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true sharegroup_label: description: __Filterable__, __Read-only__ Associated share group label. example: DevOps Base Images readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 6 x-linode-filterable: true sharegroup_uuid: description: __Filterable__, __Read-only__ The unique identifier of the share group you created a token for. example: e1d0e58b-f89f-4237-84ab-b82077342359 readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 5 x-linode-filterable: true status: description: '__Filterable__, __Read-only__ Represents the current token status. - `pending`: The token has been created but is not yet active. - `active`: The token is currently active and usable. - `revoked`: The token has been deleted and is no longer valid. - `expired`: The token has passed its validity period and is no longer usable.' enum: - pending - active - revoked - expired example: active readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 3 x-linode-filterable: true token_uuid: description: __Read-only__ A unique identifier for the token, used to reference it after creation. example: 13428362-5458-4dad-b14b-8d0d4d648f8c readOnly: true type: string x-linode-cli-display: 1 updated: description: __Read-only__ The time when this token was last updated. example: null format: date-time readOnly: true type: - string - 'null' valid_for_sharegroup_uuid: description: __Filterable__, __Read-only__ UUID identifying the associated share group. example: e1d0e58b-f89f-4237-84ab-b82077342359 readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 4 x-linode-filterable: true required: - token_uuid - status - label - created - updated - expiry - valid_for_sharegroup_uuid - sharegroup_uuid - sharegroup_label type: object x-akamai: file-path: schemas/tokens.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer required: - data - page - pages - results type: object x-akamai: file-path: schemas/get-sharegroup-tokens-200.yaml x-example: x-ref: ../examples/get-sharegroup-tokens-200.json description: Returns a paginated list of the tokens. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_only summary: List a user's tokens tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups tokens-list title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: tokens-list x-linode-redoc-load-ids: true /{apiVersion}/images/sharegroups/tokens/{tokenUuid}: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - description: A unique identifier for the token, used to reference it after creation. example: '{{tokenUuid}}' in: path name: tokenUuid required: true schema: example: 13428362-5458-4dad-b14b-8d0d4d648f8c format: uuid type: string x-akamai: file-path: parameters/token-uuid-path.yaml x-akamai: file-path: paths/images-sharegroups-tokens-id.yaml path-info: /{apiVersion}/images/sharegroups/tokens/{tokenUuid} status: BETA x-linode-cli-command: image-sharegroups get: description: 'Get details about a membership token as a share group member. Run this operation to check the `status` of a pending membership request or your current group membership. - To get the `token_uuid`, run the List tokens or Create a token operation to generate one for the share group you want to join. > --- - __CLI__. ``` linode-cli image-sharegroups token-view abc123 ``` Learn more... - __OAuth scopes__. ``` images:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-sharegroup-token operationId: get-sharegroup-token responses: '200': content: application/json: schema: additionalProperties: false description: ImageShareGroupMemberTokens object. properties: created: description: __Read-only__ When this token was created. example: '2025-08-04T10:09:09' format: date-time readOnly: true type: string expiry: description: __Read-only__ When this token expires. example: null format: date-time readOnly: true type: - string - 'null' label: description: A short description of the token. example: Backend Services - Engineering type: string x-linode-cli-display: 2 sharegroup_label: description: __Read-only__ The share group's descriptive name. example: DevOps Base Images readOnly: true type: string x-linode-cli-display: 6 sharegroup_uuid: description: __Read-only__ The share group's unique identifier. example: e1d0e58b-f89f-4237-84ab-b82077342359 readOnly: true type: string x-linode-cli-display: 5 status: description: '__Read-only__ Represents the current token status. - `pending`: The token has been created but is not yet active. - `active`: The token is currently active and usable. - `revoked`: The token has been deleted and is no longer valid. - `expired`: The token has passed its validity period and is no longer usable.' enum: - pending - active - revoked - expired example: active readOnly: true type: string x-linode-cli-display: 3 token_uuid: description: __Read-only__ A unique identifier for the token, used to reference it after creation. example: 13428362-5458-4dad-b14b-8d0d4d648f8c readOnly: true type: string x-linode-cli-display: 1 updated: description: __Read-only__ When this token was last updated. example: null format: date-time readOnly: true type: - string - 'null' valid_for_sharegroup_uuid: description: __Read-only__ The unique identifier of the share group you created a token for. example: e1d0e58b-f89f-4237-84ab-b82077342359 readOnly: true type: string x-linode-cli-display: 4 required: - token_uuid - status - label - created - updated - expiry - valid_for_sharegroup_uuid - sharegroup_uuid - sharegroup_label type: object x-akamai: file-path: schemas/token.yaml x-example: x-ref: ../examples/get-sharegroup-token-200.json description: A single token object. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_only summary: Get a token tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups token-view abc123 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: token-view x-linode-redoc-load-ids: true put: description: 'Updates the `label` of an existing membership token for a share group member or a pending membership. To get the `token_uuid`, run the List tokens or Create a token operation to generate one for the share group you want to join. > --- - __CLI__. ``` linode-cli image-sharegroups token-update abc123 --label "new_label" ``` Learn more... - __OAuth scopes__. ``` images:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/put-sharegroup-token operationId: put-sharegroup-token requestBody: content: application/json: schema: description: The membership token's details to update. properties: label: description: The descriptive name of the token. example: '{{label}}' type: string required: - label type: object x-akamai: file-path: schemas/put-sharegroup-token.yaml x-example: x-ref: ../examples/put-sharegroup-token.json responses: '200': content: application/json: schema: additionalProperties: false description: ImageShareGroupMemberTokens object. properties: created: description: __Read-only__ When this token was created. example: '2025-08-04T10:09:09' format: date-time readOnly: true type: string expiry: description: __Read-only__ When this token expires. example: null format: date-time readOnly: true type: - string - 'null' label: description: A short description of the token. example: Backend Services - Engineering type: string x-linode-cli-display: 2 sharegroup_label: description: __Read-only__ The share group's descriptive name. example: DevOps Base Images readOnly: true type: string x-linode-cli-display: 6 sharegroup_uuid: description: __Read-only__ The share group's unique identifier. example: e1d0e58b-f89f-4237-84ab-b82077342359 readOnly: true type: string x-linode-cli-display: 5 status: description: '__Read-only__ Represents the current token status. - `pending`: The token has been created but is not yet active. - `active`: The token is currently active and usable. - `revoked`: The token has been deleted and is no longer valid. - `expired`: The token has passed its validity period and is no longer usable.' enum: - pending - active - revoked - expired example: active readOnly: true type: string x-linode-cli-display: 3 token_uuid: description: __Read-only__ A unique identifier for the token, used to reference it after creation. example: 13428362-5458-4dad-b14b-8d0d4d648f8c readOnly: true type: string x-linode-cli-display: 1 updated: description: __Read-only__ When this token was last updated. example: null format: date-time readOnly: true type: - string - 'null' valid_for_sharegroup_uuid: description: __Read-only__ The unique identifier of the share group you created a token for. example: e1d0e58b-f89f-4237-84ab-b82077342359 readOnly: true type: string x-linode-cli-display: 4 required: - token_uuid - status - label - created - updated - expiry - valid_for_sharegroup_uuid - sharegroup_uuid - sharegroup_label type: object x-akamai: file-path: schemas/token.yaml x-example: x-ref: ../examples/put-sharegroup-token-200.json description: Token updated successfully. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_write summary: Update a token tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups token-update abc123 --label "new_label" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: token-update x-linode-redoc-load-ids: true delete: description: 'Removes an existing membership token for a share group member or a pending membership. - To get the `token_uuid`, run the List tokens operation. > --- - __CLI__. ``` linode-cli image-sharegroups token-delete abc123 ``` Learn more... - __OAuth scopes__. ``` images:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/delete-sharegroup-token operationId: delete-sharegroup-token responses: '200': content: application/json: schema: description: The API responds with an empty object. maxProperties: 0 type: object x-akamai: file-path: schemas/added-empty-obj.yaml x-example: x-ref: ../examples/delete-sharegroup-token-200.json description: Token deleted successfully. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_write summary: Delete a token tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups token-delete abc123 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: token-delete x-linode-grant: read_write /{apiVersion}/images/sharegroups/tokens/{tokenUuid}/sharegroup: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - description: A unique identifier for the token, used to reference it after creation. example: '{{tokenUuid}}' in: path name: tokenUuid required: true schema: example: 13428362-5458-4dad-b14b-8d0d4d648f8c format: uuid type: string x-akamai: file-path: parameters/token-uuid-path.yaml x-akamai: file-path: paths/images-sharegroups-tokens-id-sharegroup.yaml path-info: /{apiVersion}/images/sharegroups/tokens/{tokenUuid}/sharegroup status: BETA x-linode-cli-command: image-sharegroups get: description: 'Gets details about a share group you''re a member of. To get the `token_uuid`, run the Get a token or Create a token for the share group you want to join and share it with the group owner. You have to be accepted as a share group member before running this operation. > --- - __CLI__. ``` linode-cli image-sharegroups view-by-token abc123 ``` Learn more... - __OAuth scopes__. ``` images:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-sharegroup-by-token operationId: get-sharegroup-by-token responses: '200': content: application/json: schema: additionalProperties: false description: The share group's details. properties: created: description: __Read-only__ When this share group was created. example: '2025-04-14T22:44:02' format: date-time readOnly: true type: string description: description: A detailed description of this share group. example: Group of base operating system images and engineers used for CI/CD pipelines and infrastructure automation type: - string - 'null' x-linode-cli-display: 4 id: description: __Read-only__ The share group's numeric identifier, used primarily as path parameters in URLs. example: 1 readOnly: true type: integer x-linode-cli-display: 1 is_suspended: description: __Read-only__ If `true`, the share group is currently suspended. example: false readOnly: true type: boolean x-linode-cli-display: 5 label: description: The share group's descriptive name. example: DevOps Base Images type: string x-linode-cli-display: 2 updated: description: __Read-only__ When this share group was last updated. example: null format: date-time readOnly: true type: - string - 'null' uuid: description: __Read-only__ The share group's unique identifier used for membership token management. example: 1533863e-16a4-47b5-b829-ac0f35c13278 format: uuid readOnly: true type: string x-linode-cli-display: 3 required: - id - uuid - label - description - is_suspended - created - updated type: object x-akamai: file-path: schemas/get-sharegroup.yaml x-example: x-ref: ../examples/get-sharegroup-200.json description: A single share group object. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_only summary: Get a token's share group tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups view-by-token abc123 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: view-by-token x-linode-redoc-load-ids: true /{apiVersion}/images/sharegroups/tokens/{tokenUuid}/sharegroup/images: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - description: A unique identifier for the token, used to reference it after creation. example: '{{tokenUuid}}' in: path name: tokenUuid required: true schema: example: 13428362-5458-4dad-b14b-8d0d4d648f8c format: uuid type: string x-akamai: file-path: parameters/token-uuid-path.yaml x-akamai: file-path: paths/images-sharegroups-tokens-id-sharegroup-images.yaml path-info: /{apiVersion}/images/sharegroups/tokens/{tokenUuid}/sharegroup/images status: BETA x-linode-cli-command: image-sharegroups get: description: 'Lists all the shared images a member can access within a share group, using a membership token. To get the `token_uuid`, run the Get a token operation. > --- - __CLI__. ``` linode-cli image-sharegroups images-list-by-token abc123 ``` Learn more... - __OAuth scopes__. ``` images:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-sharegroup-images-by-token operationId: get-sharegroup-images-by-token responses: '200': content: application/json: schema: additionalProperties: false properties: data: items: additionalProperties: false description: The shared image's details. properties: capabilities: description: __Read-only__ A list of the possible capabilities of this image. example: - cloud-init - distributed-sites items: type: string readOnly: true type: array x-linode-cli-display: 7 created: description: __Read-only__ When this image share was created. example: '2025-08-04T10:07:59' format: date-time readOnly: true type: string created_by: description: __Read-only__ The shared image creator's username. example: null readOnly: true type: - string - 'null' deprecated: description: __Read-only__ A `true` value indicates a deprecated image. Only public images can be deprecated. readOnly: true type: boolean description: description: The shared image's detailed description. example: Official Debian Linux image for server deployment type: string x-linode-cli-display: 3 eol: description: __Read-only__ The time of the public image's planned removal from service. `null` for private images. format: date-time readOnly: true type: - string - 'null' expiry: description: __Read-only__ Only images created automatically from a deleted compute instance (`type=automatic`) expire, `null` for private images. format: date-time readOnly: true type: - string - 'null' id: description: __Read-only__ The shared image's unique idenfifier. example: shared/1 readOnly: true type: string x-linode-cli-display: 1 image_sharing: additionalProperties: false description: __Read-only__ Sharing information for the image, including who it was shared by and with. properties: shared_by: properties: sharegroup_id: description: __Read-only__ The share group's numeric identifier, used primarily as path parameters in URLs. example: 3 readOnly: true type: integer sharegroup_label: description: The share group's descriptive name. example: DevOps Base Images type: string sharegroup_uuid: description: __Read-only__ The share group's unique identifier used for membership token management. example: 8d64b99e-92f7-4c7b-a616-8f622fffb94c format: uuid readOnly: true type: string source_image_id: description: __Read-only__ The source image's slug identifier. example: private/15 readOnly: true type: string required: - sharegroup_id - sharegroup_uuid - sharegroup_label - source_image_id type: object shared_with: description: Details about who this image was shared with. example: null type: - object - 'null' readOnly: true type: object is_public: description: __Read-only__ A `true` value if the image is a public distribution image. A `false` value indicates private, account-specific images. example: true readOnly: true type: boolean x-linode-cli-display: 8 is_shared: description: __Read-only__ A `true` value for shared private images. `none` for images shared within a group. enum: - true - false - none example: none readOnly: true type: - string - 'null' x-linode-cli-display: 9 label: description: __Filterable__ The shared image's name. example: Linux Debian type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true regions: description: __Filterable__, __Read-only__ Details on the regions where this image is stored. See [Regions and images](https://techdocs.akamai.com/cloud-computing/docs/images#regions-and-images) for full details on support for `regions`. items: additionalProperties: false properties: region: description: The unique identifier for the core compute region where this image is stored. example: us-iad type: string status: description: The status of the image in this `region`. Possible values are `available`, `creating`, `pending`, `pending deletion`, `pending replication`, or `replicating`. enum: - available - creating - pending - pending deletion - pending replication - replicating example: available type: string type: object readOnly: true type: array x-akamai: labels: - Filterable size: description: __Read-only__ The minimum size in MB this image needs to deploy. example: 256 readOnly: true type: integer x-linode-cli-display: 4 status: description: __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`. enum: - creating - pending_upload - available example: available readOnly: true type: string x-linode-cli-display: 6 tags: description: __Filterable__, __Read-only__ The shared image's organizational tags. A tag can be from 3 to 100 characters long, and each image can include up to 500 tags. example: - repair-image - fix-1 items: maxLength: 100 minLength: 3 type: string maxItems: 500 minItems: 0 readOnly: true type: array x-akamai: labels: - Filterable x-linode-cli-display: 10 x-linode-filterable: true total_size: description: __Read-only__ The total size in bytes of all instances of this image, in all `regions`. example: 256 readOnly: true type: integer x-linode-cli-display: 5 type: description: __Filterable__, __Read-only__ Indicates how the image was created. It's always `shared` for images in a shared group. An `automatic` image is created automatically from a deleted compute instance. Other users within share groups can access a `shared` image. enum: - manual - automatic - shared example: shared readOnly: true type: string x-akamai: labels: - Filterable x-linode-filterable: true updated: description: __Read-only__ When this image share was last updated. example: null format: date-time readOnly: true type: - string - 'null' vendor: description: __Read-only__ The upstream distribution vendor, `null` for private and shared images. readOnly: true type: - string - 'null' required: - id - tags - type - description - label - created - updated - size - status - capabilities - is_public - is_shared - deprecated - regions - total_size - image_sharing - created_by - expiry - eol - vendor type: object x-akamai: file-path: schemas/imageshares.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer required: - data - page - pages - results type: object x-akamai: file-path: schemas/get-sharegroup-token-images-200.yaml x-example: x-ref: ../examples/get-sharegroup-token-images-200.json description: A paginated list of shared images in a share group. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_only summary: List images by token tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups images-list-by-token abc123 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: images-list-by-token x-linode-redoc-load-ids: true /{apiVersion}/images/sharegroups/{sharegroupId}: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - description: The share group's unique identifier assigned after creating it. Not to be confused with the group's `uuid`. example: '{{sharegroupId}}' in: path name: sharegroupId required: true schema: example: 54321 type: integer x-akamai: file-path: parameters/sharegroup-id-path.yaml x-akamai: file-path: paths/images-sharegroup-id.yaml path-info: /{apiVersion}/images/sharegroups/{sharegroupId} status: BETA x-linode-cli-command: image-sharegroups get: description: 'Get information about an owned share group. Run the List share groups operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. - If the `sharegroupId` in the request body belongs to a group you don''t own, calling this API will result in a 404 error. > --- - __CLI__. ``` linode-cli image-sharegroups view 1234 ``` Learn more... - __OAuth scopes__. ``` images:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-sharegroup operationId: get-sharegroup responses: '200': content: application/json: schema: additionalProperties: false description: The share group's details. properties: created: description: __Read-only__ When this share group was created. example: '2025-04-14T22:44:02' format: date-time readOnly: true type: string description: description: A detailed description of this share group. example: Group of base operating system images and engineers used for CI/CD pipelines and infrastructure automation type: - string - 'null' x-linode-cli-display: 4 expiry: description: __Read-only__ When the share group expires. example: null format: date-time readOnly: true type: - string - 'null' id: description: __Read-only__ The share group's numeric identifier, used primarily as path parameters in URLs. example: 1 readOnly: true type: integer x-linode-cli-display: 1 images_count: description: __Read-only__ The total number of images currently belonging to the share group. readOnly: true type: integer x-linode-cli-display: 6 is_suspended: description: __Read-only__ If `true`, the share group is currently suspended. example: false readOnly: true type: boolean x-linode-cli-display: 5 label: description: The share group's descriptive name. example: DevOps Base Images type: string x-linode-cli-display: 2 members_count: description: __Read-only__ The number of users with access to the share group. readOnly: true type: integer x-linode-cli-display: 7 updated: description: __Read-only__ When this share group was last updated. example: null format: date-time readOnly: true type: - string - 'null' uuid: description: __Read-only__ The share group's unique identifier used for membership token management. example: 1533863e-16a4-47b5-b829-ac0f35c13278 format: uuid readOnly: true type: string x-linode-cli-display: 3 required: - id - uuid - label - description - is_suspended - created - updated - expiry - images_count - members_count type: object x-akamai: file-path: schemas/sharegroup.yaml x-example: x-ref: ../examples/get-sharegroup-200.json description: A single share group object. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_only summary: Get a share group tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups view 1234 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: view x-linode-redoc-load-ids: true put: description: 'Updates the details of a share group you own. Run this operation to edit the `label` or `description` of a particular sharegroup. - Run the List share groups operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. - You can update either of the fields, but when you provide a new `label`, make sure that it''s not an empty string. > --- - __CLI__. ``` linode-cli image-sharegroups update 1234 --label "new_label" --description "A new description." ``` Learn more... - __OAuth scopes__. ``` images:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/put-sharegroup operationId: put-sharegroup requestBody: content: application/json: schema: additionalProperties: false description: The share group's details to update. properties: description: description: A detailed description of this share group. example: '{{description}}' type: string label: description: The share group's descriptive name. example: '{{label}}' type: string type: object x-akamai: file-path: schemas/put-sharegroup.yaml x-example: x-ref: ../examples/put-sharegroup-200.json required: true responses: '200': content: application/json: schema: additionalProperties: false description: The share group's details. properties: created: description: __Read-only__ When this share group was created. example: '2025-04-14T22:44:02' format: date-time readOnly: true type: string description: description: A detailed description of this share group. example: Group of base operating system images and engineers used for CI/CD pipelines and infrastructure automation type: - string - 'null' x-linode-cli-display: 4 expiry: description: __Read-only__ When the share group expires. example: null format: date-time readOnly: true type: - string - 'null' id: description: __Read-only__ The share group's numeric identifier, used primarily as path parameters in URLs. example: 1 readOnly: true type: integer x-linode-cli-display: 1 images_count: description: __Read-only__ The total number of images currently belonging to the share group. readOnly: true type: integer x-linode-cli-display: 6 is_suspended: description: __Read-only__ If `true`, the share group is currently suspended. example: false readOnly: true type: boolean x-linode-cli-display: 5 label: description: The share group's descriptive name. example: DevOps Base Images type: string x-linode-cli-display: 2 members_count: description: __Read-only__ The number of users with access to the share group. readOnly: true type: integer x-linode-cli-display: 7 updated: description: __Read-only__ When this share group was last updated. example: null format: date-time readOnly: true type: - string - 'null' uuid: description: __Read-only__ The share group's unique identifier used for membership token management. example: 1533863e-16a4-47b5-b829-ac0f35c13278 format: uuid readOnly: true type: string x-linode-cli-display: 3 required: - id - uuid - label - description - is_suspended - created - updated - expiry - images_count - members_count type: object x-akamai: file-path: schemas/sharegroup.yaml x-example: x-ref: ../examples/put-sharegroup-200.json description: The updated share group. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_write summary: Update a share group tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups update 1234 --label "new_label" --description "A new description." title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: update x-linode-grant: read_write delete: description: 'Deletes an owned share group. All shared group members lose access to the images within the group upon deletion. - Run the List share groups operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. > --- - __CLI__. ``` linode-cli image-sharegroups delete 1234 ``` Learn more... - __OAuth scopes__. ``` images:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/delete-sharegroup operationId: delete-sharegroup responses: '200': content: application/json: schema: description: The API responds with an empty object. maxProperties: 0 type: object x-akamai: file-path: schemas/added-empty-obj.yaml x-example: x-ref: ../examples/delete-sharegroup-200.json description: Share group delete successfully. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_write summary: Delete a share group tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups delete 1234 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: - delete - rm x-linode-grant: read_write /{apiVersion}/images/sharegroups/{sharegroupId}/images: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - description: The share group's unique identifier assigned after creating it. Not to be confused with the group's `uuid`. example: '{{sharegroupId}}' in: path name: sharegroupId required: true schema: example: 54321 type: integer x-akamai: file-path: parameters/sharegroup-id-path.yaml x-akamai: file-path: paths/images-sharegroup-id-images.yaml path-info: /{apiVersion}/images/sharegroups/{sharegroupId}/images status: BETA x-linode-cli-command: image-sharegroups post: description: 'Adds images to an existing group where you can share them with other members. - Run the List share groups operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. - Run the Get an image operation to see the existing images'' `id` values. If needed, Create an image or Upload an image. - You can set a `label` and `description` for each image, visible to all group members. If omitted, the shared image keeps the original image''s details. Note that when you Update the original image, it has no effect on a shared image''s details within any groups. > --- - __CLI__. ``` linode-cli image-sharegroups image-add 123 \ --images ''[{"id": "private/15", "label": "Linux Debian", "description": "Official Debian Linux image for server deployment"}]'' ``` Learn more... - __OAuth scopes__. ``` images:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/post-sharegroup-images operationId: post-sharegroup-images requestBody: content: application/json: schema: additionalProperties: false properties: images: items: additionalProperties: false properties: description: description: The image's description within the share group. example: Official Debian Linux image for server deployment type: string id: description: The private image’s unique slug identifier. example: private/15 type: string label: description: The image's name within the share group. example: Linux Debian type: string required: - id type: object type: array required: - images type: object x-akamai: file-path: schemas/post-sharegroup-images.yaml x-example: x-ref: ../examples/post-sharegroup-images.json responses: '200': content: application/json: schema: additionalProperties: false description: The shared image's details. properties: capabilities: description: __Read-only__ A list of the possible capabilities of this image. example: - cloud-init - distributed-sites items: type: string readOnly: true type: array x-linode-cli-display: 7 created: description: __Read-only__ When this image was shared. example: '2025-08-04T10:07:59' format: date-time readOnly: true type: string created_by: description: __Read-only__ The shared image creator's username. example: null readOnly: true type: - string - 'null' deprecated: description: __Read-only__ A `true` value indicates a deprecated image. Only public images can be deprecated. readOnly: true type: boolean description: description: The shared image's detailed description. example: Official Debian Linux image for server deployment type: string x-linode-cli-display: 3 eol: description: __Read-only__ The time of the public image's planned removal from service. `null` for private images. format: date-time readOnly: true type: - string - 'null' expiry: description: __Read-only__ Only images created automatically from a deleted compute instance (`type=automatic`) expire, `null` for private images. format: date-time readOnly: true type: - string - 'null' id: description: __Read-only__ The shared image’s unique slug identifier. example: shared/1 readOnly: true type: string x-linode-cli-display: 1 image_sharing: additionalProperties: false description: '__Read-only__ The image''s sharing details, including the share group and source image data. ' properties: shared_by: properties: sharegroup_id: description: __Read-only__ The share group's numeric identifier, used primarily as path parameters in URLs. example: 3 readOnly: true type: integer sharegroup_label: description: The share group's descriptive name. example: DevOps Base Images type: string sharegroup_uuid: description: __Read-only__ The share group's unique identifier used for membership token management. example: 8d64b99e-92f7-4c7b-a616-8f622fffb94c format: uuid readOnly: true type: string source_image_id: description: __Read-only__ The source image's slug identifier. example: private/15 readOnly: true type: string required: - sharegroup_id - sharegroup_uuid - sharegroup_label - source_image_id type: object shared_with: description: The share group's and source image details. example: null type: - object - 'null' readOnly: true type: object is_public: description: __Read-only__ A `true` value if the image is a public distribution image. A `false` value indicates private, account-specific images. example: true readOnly: true type: boolean x-linode-cli-display: 8 is_shared: description: __Read-only__ A `true` value for shared private images. `none` for images shared within a group. enum: - true - false - none example: none readOnly: true type: - string - 'null' x-linode-cli-display: 9 label: description: The shared image's name. example: Linux Debian type: string x-linode-cli-display: 2 regions: description: __Read-only__ Details on the regions where this image is stored. See [Regions and images](https://techdocs.akamai.com/cloud-computing/docs/images#regions-and-images) for full details on support for `regions`. items: additionalProperties: false properties: region: description: The unique identifier for the core compute region where this image is stored. example: us-iad type: string status: description: The status of the image in this `region`. Possible values are `available`, `creating`, `pending`, `pending deletion`, `pending replication`, or `replicating`. enum: - available - creating - pending - pending deletion - pending replication - replicating example: available type: string type: object readOnly: true type: array size: description: __Read-only__ The minimum size in MB this image needs to deploy. example: 256 readOnly: true type: integer x-linode-cli-display: 4 status: description: __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`. enum: - creating - pending_upload - available example: available readOnly: true type: string x-linode-cli-display: 6 tags: description: __Read-only__ The shared image's organizational tags. A tag can be from 3 to 100 characters long, and each image can include up to 500 tags. example: - repair-image - fix-1 items: maxLength: 100 minLength: 3 type: string maxItems: 500 minItems: 0 readOnly: true type: array x-linode-cli-display: 10 total_size: description: __Read-only__ The total size in bytes of all instances of this image, in all `regions`. example: 256 readOnly: true type: integer x-linode-cli-display: 5 type: description: __Read-only__ Indicates how the image was created. It's always `shared` for images in a shared group. An `automatic` image is created automatically from a deleted compute instance. Other users within share groups can access a `shared` image. enum: - manual - automatic - shared example: shared readOnly: true type: string updated: description: __Read-only__ When this shared image was last updated. example: null format: date-time readOnly: true type: - string - 'null' vendor: description: __Read-only__ The upstream distribution vendor, `null` for private and shared images. readOnly: true type: - string - 'null' required: - id - tags - type - description - label - created - updated - size - status - capabilities - is_public - is_shared - deprecated - regions - total_size - image_sharing - created_by - expiry - eol - vendor type: object x-akamai: file-path: schemas/imageshare.yaml x-example: x-ref: ../examples/post-sharegroup-images-200.json description: Image added successfully. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_write summary: Add images to a share group tags: - Image sharing x-akamai: tabs: - syntax: "linode-cli image-sharegroups image-add 123 \\\n --images '[{\"id\": \"private/15\", \"label\": \"Linux Debian\", \"description\": \"Official Debian Linux image for server deployment\"}]'" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: image-add x-linode-redoc-load-ids: true get: description: 'Get the details about images shared in a particular group you own. - Run the List share groups operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. > --- - __CLI__. ``` linode-cli image-sharegroups images-list 123 ``` Learn more... - __OAuth scopes__. ``` images:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-sharegroup-images operationId: get-sharegroup-images responses: '200': content: application/json: schema: additionalProperties: false properties: data: items: additionalProperties: false description: The shared image's details. properties: capabilities: description: __Read-only__ A list of the possible capabilities of this image. example: - cloud-init - distributed-sites items: type: string readOnly: true type: array x-linode-cli-display: 7 created: description: __Read-only__ When this image share was created. example: '2025-08-04T10:07:59' format: date-time readOnly: true type: string created_by: description: __Read-only__ The shared image creator's username. example: null readOnly: true type: - string - 'null' deprecated: description: __Read-only__ A `true` value indicates a deprecated image. Only public images can be deprecated. readOnly: true type: boolean description: description: The shared image's detailed description. example: Official Debian Linux image for server deployment type: string x-linode-cli-display: 3 eol: description: __Read-only__ The time of the public image's planned removal from service. `null` for private images. format: date-time readOnly: true type: - string - 'null' expiry: description: __Read-only__ Only images created automatically from a deleted compute instance (`type=automatic`) expire, `null` for private images. format: date-time readOnly: true type: - string - 'null' id: description: __Read-only__ The shared image's unique idenfifier. example: shared/1 readOnly: true type: string x-linode-cli-display: 1 image_sharing: additionalProperties: false description: __Read-only__ Sharing information for the image, including who it was shared by and with. properties: shared_by: properties: sharegroup_id: description: __Read-only__ The share group's numeric identifier, used primarily as path parameters in URLs. example: 3 readOnly: true type: integer sharegroup_label: description: The share group's descriptive name. example: DevOps Base Images type: string sharegroup_uuid: description: __Read-only__ The share group's unique identifier used for membership token management. example: 8d64b99e-92f7-4c7b-a616-8f622fffb94c format: uuid readOnly: true type: string source_image_id: description: __Read-only__ The source image's slug identifier. example: private/15 readOnly: true type: string required: - sharegroup_id - sharegroup_uuid - sharegroup_label - source_image_id type: object shared_with: description: Details about who this image was shared with. example: null type: - object - 'null' readOnly: true type: object is_public: description: __Read-only__ A `true` value if the image is a public distribution image. A `false` value indicates private, account-specific images. example: true readOnly: true type: boolean x-linode-cli-display: 8 is_shared: description: __Read-only__ A `true` value for shared private images. `none` for images shared within a group. enum: - true - false - none example: none readOnly: true type: - string - 'null' x-linode-cli-display: 9 label: description: __Filterable__ The shared image's name. example: Linux Debian type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true regions: description: __Filterable__, __Read-only__ Details on the regions where this image is stored. See [Regions and images](https://techdocs.akamai.com/cloud-computing/docs/images#regions-and-images) for full details on support for `regions`. items: additionalProperties: false properties: region: description: The unique identifier for the core compute region where this image is stored. example: us-iad type: string status: description: The status of the image in this `region`. Possible values are `available`, `creating`, `pending`, `pending deletion`, `pending replication`, or `replicating`. enum: - available - creating - pending - pending deletion - pending replication - replicating example: available type: string type: object readOnly: true type: array x-akamai: labels: - Filterable size: description: __Read-only__ The minimum size in MB this image needs to deploy. example: 256 readOnly: true type: integer x-linode-cli-display: 4 status: description: __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`. enum: - creating - pending_upload - available example: available readOnly: true type: string x-linode-cli-display: 6 tags: description: __Filterable__, __Read-only__ The shared image's organizational tags. A tag can be from 3 to 100 characters long, and each image can include up to 500 tags. example: - repair-image - fix-1 items: maxLength: 100 minLength: 3 type: string maxItems: 500 minItems: 0 readOnly: true type: array x-akamai: labels: - Filterable x-linode-cli-display: 10 x-linode-filterable: true total_size: description: __Read-only__ The total size in bytes of all instances of this image, in all `regions`. example: 256 readOnly: true type: integer x-linode-cli-display: 5 type: description: __Filterable__, __Read-only__ Indicates how the image was created. It's always `shared` for images in a shared group. An `automatic` image is created automatically from a deleted compute instance. Other users within share groups can access a `shared` image. enum: - manual - automatic - shared example: shared readOnly: true type: string x-akamai: labels: - Filterable x-linode-filterable: true updated: description: __Read-only__ When this image share was last updated. example: null format: date-time readOnly: true type: - string - 'null' vendor: description: __Read-only__ The upstream distribution vendor, `null` for private and shared images. readOnly: true type: - string - 'null' required: - id - tags - type - description - label - created - updated - size - status - capabilities - is_public - is_shared - deprecated - regions - total_size - image_sharing - created_by - expiry - eol - vendor type: object x-akamai: file-path: schemas/imageshares.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer required: - data - page - pages - results type: object x-akamai: file-path: schemas/get-sharegroups-images-200.yaml x-example: x-ref: ../examples/get-sharegroup-images-200.json description: Returns a paginated list of shared images within a given group. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_only summary: List shared images by group tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups images-list 123 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: images-list x-linode-redoc-load-ids: true /{apiVersion}/images/sharegroups/{sharegroupId}/images/{imageId}: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - description: The share group's unique identifier assigned after creating it. Not to be confused with the group's `uuid`. example: '{{sharegroupId}}' in: path name: sharegroupId required: true schema: example: 54321 type: integer x-akamai: file-path: parameters/sharegroup-id-path.yaml - description: Slug identifier assigned to the shared image upon sharing. example: '{{imageId}}' in: path name: imageId required: true schema: example: shared/7 type: string x-akamai: file-path: parameters/image-id-path-w-shared-slug.yaml x-akamai: file-path: paths/images-sharegroups-id-images-id.yaml path-info: /{apiVersion}/images/sharegroups/{sharegroupId}/images/{imageId} status: BETA x-linode-cli-command: image-sharegroups put: description: 'Updates the details of an image shared within a share group. Run this operation to edit the `label` and `description` of a particular shared image. - Run the List share groups operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. To get the `imageID`, run the List shared images by group operation. - You can update either of the fields, but when you provide a new `label`, make sure that it''s not an empty string. > --- - __CLI__. ``` linode-cli image-sharegroups image-update 123 1234 --label "new_label" --description "A new description." ``` Learn more... - __OAuth scopes__. ``` images:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/put-sharegroup-imageshare operationId: put-sharegroup-imageshare requestBody: content: application/json: schema: additionalProperties: false description: The shared image's details you want to update. properties: description: description: A detailed description of this image share. example: '{{description}}' type: string label: description: The shared image's descriptive name. example: '{{label}}' type: string type: object x-akamai: file-path: schemas/put-sharegroup-imageshare.yaml x-example: x-ref: ../examples/put-sharegroup-imageshare-200.json required: true responses: '200': content: application/json: schema: additionalProperties: false description: The shared image's details. properties: capabilities: description: __Read-only__ A list of the possible capabilities of this image. example: - cloud-init - distributed-sites items: type: string readOnly: true type: array x-linode-cli-display: 7 created: description: __Read-only__ When this image was shared. example: '2025-08-04T10:07:59' format: date-time readOnly: true type: string created_by: description: __Read-only__ The shared image creator's username. example: null readOnly: true type: - string - 'null' deprecated: description: __Read-only__ A `true` value indicates a deprecated image. Only public images can be deprecated. readOnly: true type: boolean description: description: The shared image's detailed description. example: Official Debian Linux image for server deployment type: string x-linode-cli-display: 3 eol: description: __Read-only__ The time of the public image's planned removal from service. `null` for private images. format: date-time readOnly: true type: - string - 'null' expiry: description: __Read-only__ Only images created automatically from a deleted compute instance (`type=automatic`) expire, `null` for private images. format: date-time readOnly: true type: - string - 'null' id: description: __Read-only__ The shared image’s unique slug identifier. example: shared/1 readOnly: true type: string x-linode-cli-display: 1 image_sharing: additionalProperties: false description: '__Read-only__ The image''s sharing details, including the share group and source image data. ' properties: shared_by: properties: sharegroup_id: description: __Read-only__ The share group's numeric identifier, used primarily as path parameters in URLs. example: 3 readOnly: true type: integer sharegroup_label: description: The share group's descriptive name. example: DevOps Base Images type: string sharegroup_uuid: description: __Read-only__ The share group's unique identifier used for membership token management. example: 8d64b99e-92f7-4c7b-a616-8f622fffb94c format: uuid readOnly: true type: string source_image_id: description: __Read-only__ The source image's slug identifier. example: private/15 readOnly: true type: string required: - sharegroup_id - sharegroup_uuid - sharegroup_label - source_image_id type: object shared_with: description: The share group's and source image details. example: null type: - object - 'null' readOnly: true type: object is_public: description: __Read-only__ A `true` value if the image is a public distribution image. A `false` value indicates private, account-specific images. example: true readOnly: true type: boolean x-linode-cli-display: 8 is_shared: description: __Read-only__ A `true` value for shared private images. `none` for images shared within a group. enum: - true - false - none example: none readOnly: true type: - string - 'null' x-linode-cli-display: 9 label: description: The shared image's name. example: Linux Debian type: string x-linode-cli-display: 2 regions: description: __Read-only__ Details on the regions where this image is stored. See [Regions and images](https://techdocs.akamai.com/cloud-computing/docs/images#regions-and-images) for full details on support for `regions`. items: additionalProperties: false properties: region: description: The unique identifier for the core compute region where this image is stored. example: us-iad type: string status: description: The status of the image in this `region`. Possible values are `available`, `creating`, `pending`, `pending deletion`, `pending replication`, or `replicating`. enum: - available - creating - pending - pending deletion - pending replication - replicating example: available type: string type: object readOnly: true type: array size: description: __Read-only__ The minimum size in MB this image needs to deploy. example: 256 readOnly: true type: integer x-linode-cli-display: 4 status: description: __Read-only__ The current status of the image. Possible values are `available`, `creating`, and `pending_upload`. enum: - creating - pending_upload - available example: available readOnly: true type: string x-linode-cli-display: 6 tags: description: __Read-only__ The shared image's organizational tags. A tag can be from 3 to 100 characters long, and each image can include up to 500 tags. example: - repair-image - fix-1 items: maxLength: 100 minLength: 3 type: string maxItems: 500 minItems: 0 readOnly: true type: array x-linode-cli-display: 10 total_size: description: __Read-only__ The total size in bytes of all instances of this image, in all `regions`. example: 256 readOnly: true type: integer x-linode-cli-display: 5 type: description: __Read-only__ Indicates how the image was created. It's always `shared` for images in a shared group. An `automatic` image is created automatically from a deleted compute instance. Other users within share groups can access a `shared` image. enum: - manual - automatic - shared example: shared readOnly: true type: string updated: description: __Read-only__ When this shared image was last updated. example: null format: date-time readOnly: true type: - string - 'null' vendor: description: __Read-only__ The upstream distribution vendor, `null` for private and shared images. readOnly: true type: - string - 'null' required: - id - tags - type - description - label - created - updated - size - status - capabilities - is_public - is_shared - deprecated - regions - total_size - image_sharing - created_by - expiry - eol - vendor type: object x-akamai: file-path: schemas/imageshare.yaml x-example: x-ref: ../examples/put-sharegroup-imageshare-200.json x-linode-cli-subtables: - regions description: The shared image's updated details. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_write summary: Update a shared image tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups image-update 123 1234 --label "new_label" --description "A new description." title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: image-update x-linode-grant: read_write delete: description: 'Revokes access to a shared image within an owned group for all members. - Run the List share groups operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. To get the `imageID`, run the List shared images by group operation. - To add a private image back to a share group, run the Add images to a share group. > --- - __CLI__. ``` linode-cli image-sharegroups image-remove 123 1234 ``` Learn more... - __OAuth scopes__. ``` images:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/delete-sharegroup-imageshare operationId: delete-sharegroup-imageshare responses: '200': content: application/json: schema: description: The API responds with an empty object. maxProperties: 0 type: object x-akamai: file-path: schemas/added-empty-obj.yaml x-example: x-ref: ../examples/delete-sharegroup-imageshare-200.json description: Image access deleted successfully from share group. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_write summary: Revoke access to a shared image tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups image-remove 123 1234 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: image-remove x-linode-grant: read_write /{apiVersion}/images/sharegroups/{sharegroupId}/members: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - description: The share group's unique identifier assigned after creating it. Not to be confused with the group's `uuid`. example: '{{sharegroupId}}' in: path name: sharegroupId required: true schema: example: 54321 type: integer x-akamai: file-path: parameters/sharegroup-id-path.yaml x-akamai: file-path: paths/images-sharegroup-id-members.yaml path-info: /{apiVersion}/images/sharegroups/{sharegroupId}/members status: BETA x-linode-cli-command: image-sharegroups post: description: 'Adds users to existing shared private image groups as a group owner. - Adding new members to share groups requires a single-use token. The user who wants to join a share group should run Create a token and share the `token` from the response with the group owner. - Run the List share groups operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. > --- - __CLI__. ``` linode-cli image-sharegroups member-add 123 --token "abc123" --label "my_sharegroup_member" ``` Learn more... - __OAuth scopes__. ``` images:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/post-sharegroup-members operationId: post-sharegroup-members requestBody: content: application/json: schema: additionalProperties: false properties: label: description: The share group member's descriptive name. example: '{{label}}' type: string token: description: 'The single-use JWT membership token encoded as a string. It consists of three parts: header, payload, and signature. If needed, the user should [Create a token](https://techdocs.akamai.com/linode-api/reference/post-sharegroup-tokens) and share it with the group owner before joining.' example: '{{token}}' type: string required: - token - label type: object x-akamai: file-path: schemas/post-sharegroup-members.yaml x-example: x-ref: ../examples/post-sharegroup-members.json responses: '200': content: application/json: schema: additionalProperties: false description: The shared group membership's details. properties: created: description: __Read-only__ When the user became the share group's member. example: '2025-08-04T10:07:59' format: date-time readOnly: true type: string expiry: description: __Read-only__ When the user's share group membership expires. example: null format: date-time readOnly: true type: - string - 'null' label: description: The share group member's descriptive name. example: Engineering - Backend type: string x-linode-cli-display: 2 status: description: __Read-only__ The current membership status. Share group members can be `active` or `revoked`. Revoked members' data remains available for two weeks after they left a share group. enum: - active - revoked example: active readOnly: true type: string x-linode-cli-display: 3 token_uuid: description: __Read-only__ The membership token's unique identifier. Not to be confused with the `token` needed to add a member to the share group. example: 4591075e-4ba8-43c9-a521-928c3d4a135d readOnly: true type: string x-linode-cli-display: 1 updated: description: __Read-only__ When the user's share group membership was last updated. example: null format: date-time readOnly: true type: - string - 'null' required: - token_uuid - status - label - created - updated - expiry type: object x-akamai: file-path: schemas/membership.yaml x-example: x-ref: ../examples/post-sharegroup-members-200.json description: Member added successfully. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_write summary: Add members to a share group tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups member-add 123 --token "abc123" --label "my_sharegroup_member" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: member-add x-linode-redoc-load-ids: true get: description: 'Get the details about all members in a particular share group you own. - Run the List share groups operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. > --- - __CLI__. ``` linode-cli image-sharegroups members-list 123 ``` Learn more... - __OAuth scopes__. ``` images:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-sharegroup-members operationId: get-sharegroup-members responses: '200': content: application/json: schema: additionalProperties: false properties: data: items: additionalProperties: false description: The shared group membership's details. properties: created: description: __Read-only__ When the user became the share group's member. example: '2025-08-04T10:07:59' format: date-time readOnly: true type: string expiry: description: __Read-only__ When the user's share group membership expires. example: null format: date-time readOnly: true type: - string - 'null' label: description: __Filterable__ The share group member's descriptive name. example: Engineering - Backend type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true status: description: __Filterable__, __Read-only__ The current membership status. Share group members can be `active` or `revoked`. Revoked members' data remains available for two weeks after they left a share group. enum: - active - revoked example: active readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 3 x-linode-filterable: true token_uuid: description: __Filterable__, __Read-only__ The membership token's unique identifier. Not to be confused with the `token` needed to add a member to the share group. example: 4591075e-4ba8-43c9-a521-928c3d4a135d readOnly: true type: string x-akamai: labels: - Filterable x-linode-cli-display: 1 x-linode-filterable: true updated: description: __Read-only__ When the user's share group membership was last updated. example: null format: date-time readOnly: true type: - string - 'null' required: - token_uuid - status - label - created - updated - expiry type: object x-akamai: file-path: schemas/memberships.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer required: - data - page - pages - results type: object x-akamai: file-path: schemas/get-sharegroups-members-200.yaml x-example: x-ref: ../examples/get-sharegroup-members-200.json description: Returns a paginated list of the current members linked to the targeted share group. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_only summary: List members by share group tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups members-list 123 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: members-list x-linode-redoc-load-ids: true /{apiVersion}/images/sharegroups/{sharegroupId}/members/{tokenUuid}: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - description: The share group's unique identifier assigned after creating it. Not to be confused with the group's `uuid`. example: '{{sharegroupId}}' in: path name: sharegroupId required: true schema: example: 54321 type: integer x-akamai: file-path: parameters/sharegroup-id-path.yaml - description: A unique identifier for the token, used to reference it after creation. example: '{{tokenUuid}}' in: path name: tokenUuid required: true schema: example: 13428362-5458-4dad-b14b-8d0d4d648f8c format: uuid type: string x-akamai: file-path: parameters/token-uuid-path.yaml x-akamai: file-path: paths/images-sharegroups-id-members-id.yaml path-info: /{apiVersion}/images/sharegroups/{sharegroupId}/members/{tokenUuid} status: BETA x-linode-cli-command: image-sharegroups get: description: 'Get details about a membership token as a share group owner. Run this operation to check the `status` of a pending membership request or a current group member. - Run the List share groups operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. - Get the `token_uuid` from the user who wants to join your share group or run the List members by share group operation for details on current group members. - To get details about a token as a current or pending group member, run the Get a token operation. > --- - __CLI__. ``` linode-cli image-sharegroups member-view 123 abc123 ``` Learn more... - __OAuth scopes__. ``` images:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-sharegroup-member-token operationId: get-sharegroup-member-token responses: '200': content: application/json: schema: additionalProperties: false description: The shared group membership's details. properties: created: description: __Read-only__ When the user became the share group's member. example: '2025-08-04T10:07:59' format: date-time readOnly: true type: string expiry: description: __Read-only__ When the user's share group membership expires. example: null format: date-time readOnly: true type: - string - 'null' label: description: The share group member's descriptive name. example: Engineering - Backend type: string x-linode-cli-display: 2 status: description: __Read-only__ The current membership status. Share group members can be `active` or `revoked`. Revoked members' data remains available for two weeks after they left a share group. enum: - active - revoked example: active readOnly: true type: string x-linode-cli-display: 3 token_uuid: description: __Read-only__ The membership token's unique identifier. Not to be confused with the `token` needed to add a member to the share group. example: 4591075e-4ba8-43c9-a521-928c3d4a135d readOnly: true type: string x-linode-cli-display: 1 updated: description: __Read-only__ When the user's share group membership was last updated. example: null format: date-time readOnly: true type: - string - 'null' required: - token_uuid - status - label - created - updated - expiry type: object x-akamai: file-path: schemas/membership.yaml x-example: x-ref: ../examples/get-sharegroup-member-token-200.json description: A single token object. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_only summary: Get a membership token tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups member-view 123 abc123 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: member-view x-linode-redoc-load-ids: true put: description: 'Updates an existing membership token for a group owner. You can change each token''s `label` that will be visible only to you, such as when you Get members by share group. - Run the List share groups operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. - Run the List members by share group operation to get the `token_uuid` for a current group member. > --- - __CLI__. ``` linode-cli image-sharegroups member-update 123 abc123 --label "new_label" ``` Learn more... - __OAuth scopes__. ``` images:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/put-sharegroup-member-token operationId: put-sharegroup-member-token requestBody: content: application/json: schema: additionalProperties: false description: The updated membership token's details. properties: label: description: The membership token's descriptive name. example: '{{label}}' type: string required: - label type: object x-akamai: file-path: schemas/put-sharegroup-member-token.yaml x-example: x-ref: ../examples/put-sharegroup-member-token-200.json required: true responses: '200': content: application/json: schema: additionalProperties: false description: The shared group membership's details. properties: created: description: __Read-only__ When the user became the share group's member. example: '2025-08-04T10:07:59' format: date-time readOnly: true type: string expiry: description: __Read-only__ When the user's share group membership expires. example: null format: date-time readOnly: true type: - string - 'null' label: description: The share group member's descriptive name. example: Engineering - Backend type: string x-linode-cli-display: 2 status: description: __Read-only__ The current membership status. Share group members can be `active` or `revoked`. Revoked members' data remains available for two weeks after they left a share group. enum: - active - revoked example: active readOnly: true type: string x-linode-cli-display: 3 token_uuid: description: __Read-only__ The membership token's unique identifier. Not to be confused with the `token` needed to add a member to the share group. example: 4591075e-4ba8-43c9-a521-928c3d4a135d readOnly: true type: string x-linode-cli-display: 1 updated: description: __Read-only__ When the user's share group membership was last updated. example: null format: date-time readOnly: true type: - string - 'null' required: - token_uuid - status - label - created - updated - expiry type: object x-akamai: file-path: schemas/membership.yaml x-example: x-ref: ../examples/put-sharegroup-member-token-200.json description: The updated membership token's details. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_write summary: Update a membership token tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups member-update 123 abc123 --label "new_label" title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: member-update x-linode-grant: read_write delete: description: 'Revokes a membership token accepted into a share group. Members with `revoked` status immediately lose access to shared images, and can''t deploy them anymore. - Run the List share groups operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group. - Run the List members by share group operation to get the `token_uuid` for a current group member. After revoking a membership, you can run this operation to check its status. > --- - __CLI__. ``` linode-cli image-sharegroups member-delete 123 abc123 ``` Learn more... - __OAuth scopes__. ``` images:read_write ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/delete-sharegroup-member-token operationId: delete-sharegroup-member-token responses: '200': content: application/json: schema: description: The API responds with an empty object. maxProperties: 0 type: object x-akamai: file-path: schemas/added-empty-obj.yaml x-example: x-ref: ../examples/delete-sharegroup-member-token-200.json description: Token revoked successfully. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_write summary: Revoke a membership token tags: - Image sharing x-akamai: tabs: - syntax: linode-cli image-sharegroups member-delete 123 abc123 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_write title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: member-delete x-linode-grant: read_write /{apiVersion}/images/{imageId}/sharegroups: parameters: - description: __Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta. example: '{{apiVersion}}' in: path name: apiVersion required: true schema: enum: - v4 - v4beta type: string x-akamai: file-path: parameters/api-version-path.yaml - allowReserved: false description: Slug identifier assigned to the private image upon creation. This identifier includes a slash (`/`), which must be URL-encoded in requests to prevent breaking the URL structure. example: '{{imageId}}' in: path name: imageId required: true schema: example: private/7 type: string x-akamai: file-path: parameters/image-id-path-w-private-slug.yaml x-akamai: file-path: paths/images-id-sharegroups.yaml path-info: /{apiVersion}/images/{imageId}/sharegroups status: BETA x-linode-cli-command: images get: description: 'Lists all owned share groups where a given private image is currently shared. Run the List images operation. Store the `id` for the target image as your `{imageId}`, for use in this operation''s URL path. > 📘 > > This operation returns an empty list for shared and distribution image IDs. > --- - __CLI__. ``` linode-cli images sharegroups-list private/12345 ``` Learn more... - __OAuth scopes__. ``` images:read_only ``` Learn more...' externalDocs: description: See documentation for this operation in Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference/get-images-sharegroups-image operationId: get-images-sharegroups-image responses: '200': content: application/json: schema: additionalProperties: false properties: data: items: additionalProperties: false description: The share group's details. properties: created: description: __Read-only__ When this share group was created. example: '2025-04-14T22:44:02' format: date-time readOnly: true type: string description: description: The share group's detailed description. example: Group of base operating system images and engineers used for CI/CD pipelines and infrastructure automation type: - string - 'null' x-linode-cli-display: 4 expiry: description: __Read-only__ When the share group expires. example: null format: date-time readOnly: true type: - string - 'null' id: description: The share group's numeric identifier, used primarily as path parameters in URLs. example: 1 type: integer x-linode-cli-display: 1 images_count: description: __Read-only__ The total number of images currently belonging to the share group. readOnly: true type: integer x-linode-cli-display: 6 is_suspended: description: __Read-only__ Indicates whether the share group is currently suspended. example: false readOnly: true type: boolean x-linode-cli-display: 5 label: description: __Filterable__ The share group's descriptive name. example: DevOps Base Images type: string x-akamai: labels: - Filterable x-linode-cli-display: 2 x-linode-filterable: true members_count: description: __Read-only__ The number of users with access to the share group. readOnly: true type: integer x-linode-cli-display: 7 updated: description: __Read-only__ When this share group was last updated. example: null format: date-time readOnly: true type: - string - 'null' uuid: description: The share group's unique identifier used for membership token management. example: 1533863e-16a4-47b5-b829-ac0f35c13278 format: uuid type: string x-linode-cli-display: 3 required: - id - uuid - label - description - is_suspended - created - updated - expiry - images_count - members_count type: object x-akamai: file-path: schemas/sharegroups.yaml type: array page: description: __Read-only__ The current [page](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer pages: description: __Read-only__ The total number of [pages](https://techdocs.akamai.com/linode-api/reference/pagination). example: 1 readOnly: true type: integer results: description: __Read-only__ The total number of results. example: 1 readOnly: true type: integer required: - data - page - pages - results type: object x-akamai: file-path: schemas/get-images-sharegroups-200.yaml x-example: x-ref: ../examples/get-images-sharegroups-image-200.json description: Returns a paginated list of share groups. default: content: application/json: schema: additionalProperties: false properties: errors: items: additionalProperties: false description: An object for describing a single error that occurred during the processing of a request. properties: field: description: The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as `null` if the error is not specific to any single element of the request. example: fieldname type: string reason: description: What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to [Open a support ticket](https://techdocs.akamai.com/linode-api/reference/post-ticket) or perform some other action before you can complete the request successfully. example: fieldname must be a valid value type: string type: object x-akamai: file-path: schemas/error-object.yaml type: array type: object description: See [Errors](https://techdocs.akamai.com/linode-api/reference/errors) for the range of possible error response codes. security: - personalAccessToken: [] - oauth: - images:read_only summary: List share groups by image tags: - Image sharing x-akamai: tabs: - syntax: linode-cli images sharegroups-list private/12345 title: CLI url: https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli - syntax: images:read_only title: OAuth scopes url: https://techdocs.akamai.com/linode-api/reference/get-started#oauth x-linode-cli-action: sharegroups-list x-linode-redoc-load-ids: true components: securitySchemes: oauth: flows: authorizationCode: authorizationUrl: https://login.linode.com/oauth/authorize scopes: account:read_only: Allows access to GET information about your account. account:read_write: Allows access to all endpoints related to your account. domains:read_only: Allows access to GET Domains on your account. domains:read_write: Allows access to all Domain endpoints. events:read_only: Allows access to GET your Events. events:read_write: Allows access to all endpoints related to your Events. firewall:read_only: Allows access to GET information about your Firewalls. firewall:read_write: Allows access to all Firewall endpoints. images:read_only: Allows access to GET your Images. images:read_write: Allows access to all endpoints related to your Images. ips:read_only: Allows access to GET your ips. ips:read_write: Allows access to all endpoints related to your ips. linodes:read_only: Allows access to GET Linodes on your account. linodes:read_write: Allow access to all endpoints related to your Linodes. lke:read_only: Allows access to GET LKE Clusters on your account. lke:read_write: Allows access to all endpoints related to LKE Clusters on your account. longview:read_only: Allows access to GET your Longview Clients. longview:read_write: Allows access to all endpoints related to your Longview Clients. monitor:read-write: Allows access to all Monitor (Akamai Cloud Pulse) endpoints. monitor:read_only: Allows access to Monitor (Akamai Cloud Pulse) data. nodebalancers:read_only: Allows access to GET NodeBalancers on your account. nodebalancers:read_write: Allows access to all NodeBalancer endpoints. object_storage:read_only: Allows access to GET information related to your Object Storage. object_storage:read_write: Allows access to all Object Storage endpoints. stackscripts:read_only: Allows access to GET your StackScripts. stackscripts:read_write: Allows access to all endpoints related to your StackScripts. volumes:read_only: Allows access to GET your Volumes. volumes:read_write: Allows access to all endpoints related to your Volumes. vpc:read_write: Allows access to all endpoints related to VPC and Subnet creation, updating, and deletion. tokenUrl: https://login.linode.com/oauth/token type: oauth2 personalAccessToken: scheme: bearer type: http externalDocs: description: See documentation for Akamai's Linode API url: https://techdocs.akamai.com/linode-api/reference x-readme: samples-languages: - curl - python - node