coder/docs/api/general.md

General

This page is incomplete, stay tuned.

API root handler

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/ \
  -H 'Accept: application/json'

GET /

Example responses

200 Response

{
  "detail": "string",
  "message": "string",
  "validations": [
    {
      "detail": "string",
      "field": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Response

undefined

Build info

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/buildinfo \
  -H 'Accept: application/json'

GET /buildinfo

Example responses

200 Response

{
  "external_url": "string",
  "version": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.BuildInfoResponse

undefined

Report CSP violations

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/csp/reports \
  -H 'Content-Type: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /csp/reports

Body parameter

{
  "csp-report": {}
}

Parameters

Name	In	Type	Required	Description
body	body	coderd.cspViolation	true	Violation report

Responses

Status	Meaning	Description	Schema
200	OK	OK

To perform this operation, you must be authenticated by means of one of the following methods: CoderSessionToken.

Update check

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/updatecheck \
  -H 'Accept: application/json'

GET /updatecheck

Example responses

200 Response

{
  "current": true,
  "url": "string",
  "version": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.UpdateCheckResponse

undefined