@akamai/openapi-ts
    Preparing search index...

    Type Alias PutObjectStorageKeyData

    type PutObjectStorageKeyData = {
        body?: { label?: string; regions?: string[] };
        path: { keyId: number };
        query?: never;
        url: "object-storage/keys/{keyId}";
    }
    Index

    Properties

    Properties

    body?: { label?: string; regions?: string[] }

    The fields to update.

    Type Declaration

    • Optionallabel?: string

      The label for the Object Storage key. Used for display purposes. Omit this to leave the label unchanged.

    • Optionalregions?: string[]

      Replace the current list of regions set in a specific key. Include an existing region to keep it, or leave it out to remove it. Omit the regions array to leave the existing list unchanged. If you include new regions in the key, you can't immediately use the key to manage content in buckets in those regions. You need to grant these keys this access using bucket policies.

      🚧 Limited keys have restrictions

      These points apply to keys you've created using the bucket_access array:

      • You can't remove a region from a limited key's original bucket_access list. If you include the regions array in this operation and target a limited key, you need to include all existing region entries from the bucket_access array. Otherwise, the operation fails with an error. Run Get an Object Storage key to review current region entries in a limited key.

      • If you need to remove a specific region from an active limited key, you can revoke the key and create a new Object Storage key, without the specific region.

    path: { keyId: number }

    Type Declaration

    • keyId: number

      The key to look up.

    query?: never
    url: "object-storage/keys/{keyId}"