RUrudder
API Info

Get information about one API endpoint

Changed on

Get the description and the list of supported version for one API endpoint

get/info/details/{endpointName}

Request

Path parameters

endpointNamestring required
Example:listAcceptedNodes

Name of the endpoint for which one wants information

Response

API Endpoint information

result'success' | 'error' required

Result of the request

action'apiInformations' required

The id of the action

Example response

{
  "data": {
    "endpoints": [
      {
        "listAcceptedNodes": "List all accepted nodes with configurable details level",
        "GET": "[8,9,10,11,12,13] /nodes"
      }
    ]
  }
}

Changes

  • eecc9e1231f6Revision changes
    • warning

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

    • warning

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