Sign in
security-servers

find security servers

Changed on
<h3>CS administrator searches for X-Road Security Servers that are registered in the central server.</h3>
get/security-servers

Request

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

Query parameters

qstring text
Example:foobar

An optional generic filtering query parameter selects only items that contain parameter value in visible properties server code, server owner name, server owner class and owner code. Needs to be properly encoded for the special characters, too. Empty value means the parameter is ignored.

sortstring

Indicates item property that is to be used as sorting key.

descboolean

Used sorting direction. Value 'true' indicates descending and 'false' or omitted parameter indicates ascending direction.

limitinteger

Indicates the maximum number of items for the returned page. If parameter is omitted, then the default amount of 25 is returned.

offsetinteger

Offset in pages from the beginning of the query result after filtering and sorting parameters are taken into account. If the parameter omitted or the value 0 (zero) is given, the first page is returned.

optional paging and sorting parameters. Sorting possible according to one of the following values: <ul> <li><b>xroad_id.server_code</b> for server code ,</li> <li><b>owner_name</b> for server owner name,</li> <li><b>xroad_id.member_class</b> for server owner class or</li> <li><b>xroad_id.member_code</b> for owner code.</li>

</ul>
{
  "sort": "title"
}

Response

paged security servers results

Example response

{
  "items": [
    {
      "server_address": "192.168.1.100",
      "created_at": "2022-01-20T00:00:00.001Z",
      "updated_at": "2022-01-22T07:30:00.001Z",
      "server_id": {
        "instance_id": "FI",
        "member_class": "GOV",
        "server_code": "server123"
      }
    }
  ]
}

Changes

  • 72c3c9c00de3Revision changes
    • ○

      mapped value for discriminator key MEMBER changed from ClientId to for ////// response property for the response status

    • ○

      mapped value for discriminator key SERVER changed from SecurityServerId to for ////// response property for the response status

    • ○

      mapped value for discriminator key SUBSYSTEM changed from ClientId to for ////// response property for the response status

  • 49854d95889cRevision changes
    • ▲

      the /////// response's property format changed from text§ to text for status