---
title: "Claim a network agent"
method: POST
path: "/agents"
tags: ["Network Agents"]
---

# Claim a network agent

`POST /agents`

## Request

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

Claims an unclaimed network agent using its claim code and registers it to the current account.

## Request body

- AgentObject
  - `agent` object, required
    - `claim_code` string, required

## Response `200`

Success

- Agent
  - `id` integer
  - `created_at` string
  - `identifier` string
  - `name` string
  - `online` boolean
  - `revoked_at` string, nullable
  - `updated_at` 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)