Sign in
services

create endpoint

Changed on
<h3>Administrator creates a new endpoint.</h3>
post/services/{id}/endpoints

Request

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

Path parameters

idstring text required
Example:CS:ORG:Client:myService.v1

id of the service

Request body

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 request

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

Response

endpoint added

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