Rebrand 2023 Learn more 

  • Commerce Cloud/
    Authentication/
    Application Keys/
    Update an Application Key

    Update an Application Key

    PUT Update an Application Key

    https://useast.api.elasticpath.com/v2/application-keys/:id
    

    Parameters

    Path parameters

    NameRequiredTypeDescription
    idRequiredstringThe unique identifier of the application key to be updated.

    Headers

    NameRequiredTypeDescription
    AuthorizationRequiredstringThe Bearer token required to get access to the API.

    Body

    NameRequiredTypeDescription
    typeRequiredstringRepresents the type of object being returned. Always application_key.
    nameRequiredstringSpecifies the new name of the application key to be updated.

    Request Example - Curl

    curl -X PUT https://useast.api.elasticpath.com/v2/application-keys/:id \
         -H "Authorization: Bearer XXXX" \
         -H "Content-Type: application/json" \
         -d $ {
           "data":
           {
            "type": "application_key",
            "name": "New Key Name"
          }
        }
    

    Response Example

    200 OK

    {
        "data": {
            "id": "ba9ef8a0-075d-4a6f-b888-8fb080a1ae5d",
            "name": "New Key Name",
            "type": "application_key",
            "client_id": "d41f447c7b87eb043ad55f641c7e5e3f176e5843c2",
            "reserved_rate_limit": 0,
            "meta": {
                "timestamps": {
                    "last_used_at": "2022-10-11T12:44:16.309Z",
                    "created_at": "2022-10-11T12:44:16.309Z",
                    "updated_at": "2022-10-11T12:44:16.309Z"
                }
            }
        },
        "links": {
            "self": "https://useast.api.elasticpath.com/v2/application-keys/ba9ef8a0-075d-4a6f-b888-8fb080a1ae5d"
        }
    }
    
    Previous
    Delete an Application Key