---
title: "POST /agent/register"
method: POST
path: "/agent/register"
tags: ["Service"]
---

# POST /agent/register

`POST /agent/register`

## Request body

- ApiAgentRegisterInput
  - `arch` string
  - `auth_salt` string
  - `default_agent` boolean
  - `domain_suffix` string
  - `hostname` string
  - `metadata` string
  - `name` string
  - `nginx_port` integer
  - `os` string
  - `tags` string[]
  - `version` string

## Response `200`

A successful response.

- ApiAgentRegisterOutput
  - `agent` DbAgent
    - `arch` string
    - `auth_salt` string
    - `challenge_instances` DbChallengeInstance[]
      - `agent` DbAgent — recursive
      - `agent_id` string, int64
      - `created_at` string, date-time
      - `flavor` DbChallengeFlavor
        - `body` string
        - `category` string
        - `challenge` DbChallenge
          - `author` string
          - `created_at` string, date-time
          - `description` string
          - `flavors` DbChallengeFlavor[]
          - `homepage` string
          - `id` string, int64
          - `is_draft` boolean
          - `locale` string
          - `name` string
          - `preview_url` string
          - `slug` string
          - `updated_at` string, date-time
        - `challenge_id` string, int64
        - `compose_bundle` string
        - `created_at` string, date-time
        - `driver` 'Unknown' | 'Docker' | 'DockerCompose'
        - `id` string, int64
        - `instances` DbChallengeInstance[]
        - `passphrases` string, int64
        - `purchase_price` string, int64
        - `redump_policy` ChallengeFlavorRedumpPolicy[]
          - `delay` string
          - `strategy` string
        - `redump_policy_config` string
        - `season_challenges` DbSeasonChallenge[]
          - `created_at` string, date-time
          - `flavor` DbChallengeFlavor — recursive
          - `flavor_id` string, int64
          - `id` string, int64
          - `nb_validations` string, int64
          - `season` DbSeason
            - `coupons` DbCoupon[]
              - …
            - `created_at` string, date-time
            - `id` string, int64
            - `is_global` boolean
            - `is_testing` boolean
            - `name` string
            - `rules_bundle` string
            - `slug` string
            - `status` 'UnknownStatus' | 'Started' | 'Stopped'
            - `subscription` 'UnknownSubscription' | 'Open' | 'Close'
            - `teams` DbTeam[]
              - …
            - `updated_at` string, date-time
            - `visibility` 'UnknownVisibility' | 'Private' | 'Unlisted' | 'Public'
          - `season_id` string, int64
          - `slug` string
          - `subscriptions` DbChallengeSubscription[]
            - `buyer` DbUser
              - …
            - `buyer_id` string, int64
            - `closed_at` string, date-time
            - `closer` DbUser
              - …
            - `closer_id` string, int64
            - `created_at` string, date-time
            - `id` string, int64
            - `season_challenge` DbSeasonChallenge — recursive
            - `season_challenge_id` string, int64
            - `slug` string
            - `status` 'Unknown' | 'Active' | 'Closed'
            - `team` DbTeam
              - …
            - `team_id` string, int64
            - `updated_at` string, date-time
            - `validations` DbChallengeValidation[]
              - …
          - `updated_at` string, date-time
        - `slug` string
        - `source_url` string
        - `tag_list` string
        - `tags` string[]
        - `updated_at` string, date-time
        - `validation_reward` string, int64
        - `version` string
      - `flavor_id` string, int64
      - `id` string, int64
      - `instance_config` string, byte
      - `last_redump_requested_at` string, date-time
      - `last_started_at` string, date-time
      - `last_stopped_at` string, date-time
      - `nginx_url` string
      - `redump_count` string, int64
      - `slug` string
      - `startup_error` string
      - `status` 'Unknown' | 'IsNew' | 'AcceptedByAgent' | 'Available' | 'NeedRedump' | 'Disabled'
      - `updated_at` string, date-time
      - `validation_count` string, int64
    - `created_at` string, date-time
    - `default_agent` boolean
    - `domain_suffix` string
    - `err_msg` string
    - `hostname` string
    - `id` string, int64
    - `last_registration_at` string, date-time
    - `last_seen_at` string, date-time
    - `metadata` string
    - `name` string
    - `nginx_port` string, int64
    - `os` string
    - `slug` string
    - `status` 'Unknown' | 'Active' | 'Inactive' | 'Timeout' | 'Error'
    - `tags` string
    - `times_registered` string, int64
    - `times_seen` string, int64
    - `updated_at` string, date-time
    - `version` string

## Other responses

- `403` — Returned when the user does not have permission to access the resource.
- `404` — Returned when the resource does not exist.
- `default` — An unexpected error response

---

[API](https://skmtc.net/pathwar/apis/pathwar-api.md) · [All operations](https://skmtc.net/pathwar/apis/pathwar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pathwar/pathwar-api/versions/96fed8bdb175/schema)