Sign in
services

update service

Changed on
<h3>Administrator updates the service.</h3> <p> This endpoint can return a warnings response which can be ignored by setting <code>ServiceUpdate.ignore_warnings</code> = true. If <code>ServiceUpdate.ignore_warnings</code> = false, it is possible to receive a warnings response from this endpoint if any one of the following conditions is true <ul> <li>SSL authentication is set to true, but https connection to the service URL fails because SSL handshake fails</li> <li>SSL authentication is set to true, but https connection to the service URL fails because of other errors (e.g. host unreachable)</li> </ul> </p>
patch/services/{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/services/{id}
  • Auth: API key in header Authorization

Path parameters

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

id of the service

Request body

urlstring url required

service url

timeoutinteger required

service time out value

ssl_authboolean required

service ssl auth

url_allboolean

url is applied for all services

timeout_allboolean

timeout value is applied for all services

ssl_auth_allboolean

ssl authentication is applied for all services

ignore_warningsboolean

if true, any ignorable warnings are ignored. if false (or missing), any warnings cause request to fail

Example request

{
  "url": "https://domain.com/service",
  "timeout": 60,
  "ssl_auth": true
}

Response

service modified

idstring text required

encoded service id, including client id

service_description_idstring required

unique identifier

client_idstring text required

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

full_service_codestring text

encoded service code and version

service_codestring text required

encoded service code

timeoutinteger required

service time out value

titlestring text

service title

ssl_authboolean

service ssl auth

subjects_countinteger

count of acl subjects

urlstring url required

service url

Example response

{
  "id": "CS:ORG:Client:myService.v1",
  "client_id": "FI:GOV:123:ABC",
  "full_service_code": "myService.v1",
  "service_code": "myService",
  "timeout": 60,
  "title": "client deletion",
  "ssl_auth": true,
  "subjects_count": 5,
  "url": "https://domain.com/service",
  "endpoints": [
    {
      "service_code": "example_service_code",
      "client_id": "FI:GOV:123:ABC",
      "method": "GET",
      "path": "/foo",
      "generated": true
    }
  ]
}

Changes

  • 26d051d8c39eRevision changes
    • ○

      added the optional property // to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

  • 86ab791a2584Revision changes
    • ▲

      removed the required property from the response with the status

    • ▲

      removed the required property from the response with the status

    • ●

      removed the optional property // from the response with the status