Residencies

Data residency.

1 endpoint · Plakar Control Plane v0.18 · Base URL, authentication and errors

List the residencies

GET /api/v1/residencies
Badge
ISO 3166-1 alpha-2 countries.

Response 200 OK application/json

  • residencies array[object]
    • alpha2 string
    • alpha3 string
    • common_name string
    • eea boolean
    • eu boolean
    • name string
    • numeric string
    • region string nullable
    • sub_region string nullable

Errors

  • 400 Bad Request (validation or deserialization error)
  • 401 Missing, invalid or expired credentials
  • 403 The caller may not do this
  • 500 Internal Server Error (panics)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/residencies' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "residencies": [
    {
      "alpha2": "string",
      "alpha3": "string",
      "common_name": "string",
      "eea": true,
      "eu": true,
      "name": "string",
      "numeric": "string",
      "region": "string",
      "sub_region": "string"
    }
  ]
}

Product

Integrations

Resources

Company

Newsletter