--- updatedAt: 2026-08-24T15:06:26.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/linode-api/llms.txt --- # Update a share group __Beta__ 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](ref:get-sharegroups) 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. > 📘 > > This operation is in Beta and available from the `v4beta` URL. **Permissions and scopes** To call this operation, you need the following: - **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth). - Scopes: `images:read_write` **CLI** ```shell linode-cli image-sharegroups update 1234 --label "new_label" --description "A new description." ``` [Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli) # OpenAPI definition ````json { "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.", "databases:read_only": "Allows access to GET information about databases.", "databases:read_write": "Allows access to all endpoints related to databases.", "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" }, "info": { "description": "\"[Read the API documentation](https://techdocs.akamai.com/linode-api/reference/api).\"", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Images", "version": "4.229.1" }, "openapi": "3.0.1", "paths": { "/{apiVersion}/images/sharegroups/{sharegroupId}": { "put": { "description": "__Beta__ Updates the details of a share group you own. Run this operation to edit the `label` or `description` of a particular sharegroup.\n\n- Run the [List share groups](https://techdocs.akamai.com/linode-api/reference/get-sharegroups) operation to get the `id` you should use as the `(sharegroupId)` path parameter that identifies an existing share group.\n\n- You can update either of the fields, but when you provide a new `label`, make sure that it's not an empty string.\n\n> 📘\n>\n> This operation is in Beta and available from the `v4beta` URL.\n\n\n**Permissions and scopes**\n\nTo call this operation, you need the following:\n\n- **OAuth scopes**. Your user needs these scopes assigned. [Learn more](https://techdocs.akamai.com/linode-api/reference/get-started#oauth).\n\n - Scopes: `images:read_write`\n\n\n**CLI**\n\n```shell\nlinode-cli image-sharegroups update 1234 --label \"new_label\" --description \"A new description.\"\n```\n\n[Learn more](https://techdocs.akamai.com/cloud-computing/docs/getting-started-with-the-linode-cli)", "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": { "example": { "description": "Group of base operating system images and engineers used for CI/CD pipelines and infrastructure automation", "label": "DevOps Base Images" }, "schema": { "additionalProperties": false, "description": "The share group's details to update.", "properties": { "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" }, "label": { "description": "The share group's descriptive name.", "example": "DevOps Base Images", "type": "string" } }, "type": "object", "x-akamai": { "file-path": "schemas/put-sharegroup.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "created": "2025-04-14T22:44:02", "description": "Group of base operating system images and engineers used for CI/CD pipelines and infrastructure automation", "expiry": null, "id": 1, "images_count": 0, "is_suspended": false, "label": "DevOps Base Images", "members_count": 0, "updated": null, "uuid": "1533863e-16a4-47b5-b829-ac0f35c13278" }, "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", "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", "nullable": true, "type": "string", "x-linode-cli-display": 4 }, "expiry": { "description": "__Read-only__ When the share group expires.", "example": null, "nullable": true, "readOnly": true, "type": "string" }, "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, "nullable": true, "readOnly": true, "type": "string" }, "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" } } } }, "description": "The updated share group." }, "default": { "content": { "application/json": { "example": { "errors": [ { "reason": "Invalid JSON" } ] }, "schema": { "additionalProperties": false, "properties": { "errors": { "description": "Any warnings associated with a response.", "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": { "status": "BETA", "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" } ] }, "x-linode-cli-action": "update", "x-linode-grant": "read_write" }, "parameters": [ { "description": "__Enum__ Call either the `v4` URL, or `v4beta` for operations still in Beta.", "in": "path", "name": "apiVersion", "required": true, "schema": { "enum": [ "v4", "v4beta" ], "example": "v4", "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`.", "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}" }, "x-linode-cli-command": "image-sharegroups" } }, "servers": [ { "url": "https://api.linode.com" } ], "tags": [ { "description": "Use these operations to create and mange groups of users that can access your stored images.", "name": "Image sharing" } ], "x-akamai": { "auth-type": "OAUTH", "file-path": "images.yaml" }, "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } } ```` # Sibling pages * [Create a share group](https://techdocs.akamai.com/linode-api/reference/post-sharegroups.md) * [List share groups](https://techdocs.akamai.com/linode-api/reference/get-sharegroups.md) * [Create a token](https://techdocs.akamai.com/linode-api/reference/post-sharegroup-tokens.md) * [List a user's tokens](https://techdocs.akamai.com/linode-api/reference/get-user-tokens.md) * [Get a token's share group](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-by-token.md) * [List images by token](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-images-by-token.md) * [Get a share group](https://techdocs.akamai.com/linode-api/reference/get-sharegroup.md) * [Delete a share group](https://techdocs.akamai.com/linode-api/reference/delete-sharegroup.md) * [Add images to a share group](https://techdocs.akamai.com/linode-api/reference/post-sharegroup-images.md) * [List shared images by group](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-images.md) * [Update a shared image](https://techdocs.akamai.com/linode-api/reference/put-sharegroup-imageshare.md) * [Revoke access to a shared image](https://techdocs.akamai.com/linode-api/reference/delete-sharegroup-imageshare.md) * [Add members to a share group](https://techdocs.akamai.com/linode-api/reference/post-sharegroup-members.md) * [List members by share group](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-members.md) * [Get a membership token](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-member-token.md) * [Update a membership token](https://techdocs.akamai.com/linode-api/reference/put-sharegroup-member-token.md) * [Revoke a membership token](https://techdocs.akamai.com/linode-api/reference/delete-sharegroup-member-token.md) * [List share groups by image](https://techdocs.akamai.com/linode-api/reference/get-images-sharegroups-image.md) * [Get a token](https://techdocs.akamai.com/linode-api/reference/get-sharegroup-token.md) * [Update a token](https://techdocs.akamai.com/linode-api/reference/put-sharegroup-token.md) * [Delete a token](https://techdocs.akamai.com/linode-api/reference/delete-sharegroup-token.md)