---
title: "Create an API key"
method: POST
path: "/security/api_keys"
tags: ["Security"]
---

# Create an API key

`POST /security/api_keys`

## Request

- Base URL: `https://sg.deployhq.com`
- URL: `https://sg.deployhq.com/security/api_keys`
- Auth: HTTP basic

Creates a new API key for the authenticated user. The full key value is only returned once in this response.

## Request body

- ApiKeyObject
  - `api_key` object, required
    - `description` string, required
    - `read_only` boolean

## Response `200`

Success

- ApiKeyIdentifierDescriptionObject
  - `api_key` string
  - `identifier` string
  - `description` string
  - `user_id` integer
  - `device` string
  - `read_only` boolean
  - `html` string

## Other responses

- `401`: You are not authorized to access this resource. You need to authenticate yourself first.
- `403`: You are not allowed to access this resource. You do not have the necessary permissions.
- `422`: Unprocessable Entity
- `500`: An unexpected error occurred on the server. The server was unable to process the request.

---

[API](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation.md) · [All operations](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/deployhq/apis/deployhq-api-interactive-documentation/revisions/830264ae58be?raw)