HEAD-agents.md

RMap Agent Service Status

Provides link to API documentation and a list of available HTTP verbs for the Agent path.

• Request
  • HTTP Method & Path
  • Request Headers
  • Request Body
• Response
  • Response Headers
  • Response Body
  • Possible Response Codes
• Behavior
• Example

Request

HTTP Method & Path

HEAD /agents

Example URL: https://test.rmap-hub.org/api/agents

Request Headers

none

Request Body

none

Response

Response Headers

Header	Value
Allow	HEAD, OPTIONS, GET
Link	<https://link_to_documentation>; rel="http://purl.org/dc/terms/description"

Response Body

none

Possible Response Codes

Code	Description
200	OK
500	Internal server error
503	Service unavailable

Behavior

1. If the system is working correctly, an OK response will be returned with a list of available HTTP methods in the header, and a link to the technical documentation as specified in the rmapapi.documentationPath property. The response will return no body.

Example

Request

curl -i -I HEAD https://test.rmap-hub.org/api/agents

Response

HTTP/1.1 200 OK
Allow: HEAD,OPTIONS,GET
Link: <https://github.com/rmap-project/rmap-documentation>;rel="http://purl.org/dc/elements/1.1/description"

[no content]