Sign in
security-servers

get security server information

<h3>Administrator views the details of a security server.</h3>
get/security-servers/{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/security-servers/{id}
  • Auth: API key in header Authorization

Path parameters

idstring text required

<instance_id>:<member_class>:<member_code>:<security_server_code>

Example:FI:GOV:123:sserver1

id of the security server

Response

ok

idstring text required

<instance_id>:<member_class>:<member_code>:<security_server_code>

instance_idstring text

xroad instance id

member_classstring text

member class

member_codestring text

member code

server_codestring text

security server code

server_addressstring text

security server address (ip or name)

Example response

{
  "id": "FI:GOV:123:sserver1",
  "instance_id": "FI",
  "member_class": "GOV",
  "server_code": "server123",
  "server_address": "192.168.1.100"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.