# Update an API Key

Updates an API Key.

: currently only keys of type  are supported.


Endpoint: PATCH /2/teams/{teamSlug}/api-keys/{ID}
Version: 1.0.0
Security: bearerAuth

## Path parameters:

  - `teamSlug` (string, required)
    The slug of the Team

  - `ID` (string, required)
    A unique identifier

## Request fields (application/vnd.api+json):

  - `data` (object, required)

  - `data.id` (string, required)
    The unique identifier of the API Key
    Example: "hcxik_12345678901234567890123456"

  - `data.type` (string, required)
    Enum: "api-keys"

  - `data.attributes` (object, required)

  - `data.attributes.name` (string)
    A human-readable name for the API Key
    Example: "updated key name"

  - `data.attributes.enabled` (boolean)
    Whether the API Key is enabled

## Response 200 fields (application/vnd.api+json):

  - `data` (object, required)

  - `data.id` (string)
    The unique identifier of the API Key
    Example: "hcxik_12345678901234567890123456"

  - `data.type` (string)
    Enum: "api-keys"

  - `data.attributes` (object)

  - `data.attributes.key_type` (string)
    The type of API Key
    Enum: "ingest"

  - `data.attributes.name` (string, required)
    A human-readable name for the API Key
    Example: "us-west-2 collectors key"

  - `data.attributes.disabled` (boolean)
    Whether the API Key is disabled

  - `data.attributes.permissions` (object)
    The permissions granted to this API Key

  - `data.attributes.permissions.create_datasets` (boolean)
    Whether this API Key can create new Datasets

  - `data.attributes.timestamps` (object)

  - `data.attributes.timestamps.created` (string)
    The ISO8601-formatted time when the API Key was created.
    Example: "2022-09-22T17:32:11Z"

  - `data.attributes.timestamps.updated` (string)
    The ISO8601-formatted time when the API Key was updated.
    Example: "2022-10-31T15:08:11Z"

  - `data.relationships` (object)

  - `data.relationships.environment` (object, required)
    The Environment this object is associated with.

  - `data.relationships.creator` (object, required)
    The User who initially created this resource.

  - `data.relationships.editor` (object, required)
    The User who last edited this resource.

  - `data.links` (object)

  - `data.links.self` (string)
    The URL of this resource
    Example: "/2/teams/my-team/api-keys/hcxik_12345678901234567890123456"

## Response 400 fields (application/problem+json):

  - `error` (string, required)

  - `status` (number, required)
    The HTTP status code of the error.

  - `type` (string, required)
    Type is a URI used to uniquely identify the type of error.

  - `title` (string, required)
    Title is a human-readable summary that explains the  of the problem.

  - `detail` (string)
    The general, human-readable error message.

  - `instance` (string)
    The unique identifier (ID) for this specific error.

## Response 401 fields (application/json):

  - `error` (string)

## Response 403 fields (application/json):

  - `error` (string)

## Response 404 fields (application/json):

  - `error` (string)

## Response 413 fields (application/json):

  - `error` (string, required)

  - `status` (number, required)
    The HTTP status code of the error.

  - `type` (string, required)
    Type is a URI used to uniquely identify the type of error.

  - `title` (string, required)
    Title is a human-readable summary that explains the  of the problem.

  - `detail` (string)
    The general, human-readable error message.

  - `instance` (string)
    The unique identifier (ID) for this specific error.

## Response 415 fields (application/vnd.api+json):

  - `errors` (array)

  - `errors.id` (string, required)

  - `errors.status` (string)

  - `errors.code` (string, required)

  - `errors.title` (string)

  - `errors.detail` (string)

  - `errors.source` (object)

  - `errors.source.pointer` (string)

  - `errors.source.header` (string)

  - `errors.source.parameter` (string)

## Response 422 fields (application/problem+json):

  - `error` (string, required)

  - `status` (number, required)
    The HTTP status code of the error.

  - `type` (string, required)
    Type is a URI used to uniquely identify the type of error.

  - `title` (string, required)
    Title is a human-readable summary that explains the  of the problem.

  - `detail` (string)
    The general, human-readable error message.

  - `instance` (string)
    The unique identifier (ID) for this specific error.

  - `type_detail` (array)

  - `type_detail.field` (string)

  - `type_detail.code` (string)
    Enum: "invalid", "missing", "incorrect_type", "already_exists"

  - `type_detail.description` (string)

## Response 429 fields (application/json):

  - `error` (string)

## Response 500 fields (application/problem+json):

  - `error` (string, required)

  - `status` (number, required)
    The HTTP status code of the error.

  - `type` (string, required)
    Type is a URI used to uniquely identify the type of error.

  - `title` (string, required)
    Title is a human-readable summary that explains the  of the problem.

  - `detail` (string)
    The general, human-readable error message.

  - `instance` (string)
    The unique identifier (ID) for this specific error.