Sign in
endpoints

Get an endpoint by its id

Changed on
<h3>Administrator fetches an endpoint.</h3>
get/endpoints/{id}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/endpoints/{id}
  • Auth: API key in header Authorization

Path parameters

idstring text required

id of the endpoint

Response

endpoint

idstring

unique identifier

service_codestring required

service code

client_idstring text

<instance_id>:<member_class>:<member_code>:<subsystem>(optional)

method'*' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | 'TRACE' required

http method mapped to this endpoint

pathstring required

relative path where this endpoint is mapped to

generatedboolean

has endpoint been generated from openapi3 description

Example response

{
  "service_code": "example_service_code",
  "client_id": "FI:GOV:123:ABC",
  "method": "GET",
  "path": "/foo",
  "generated": true
}

Changes