Skip to main content

List Nodes

GET/api/v1/nodes/

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key for authenticating the request

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Specifies the location filter for the node list request.

    • must be a non-empty string
    • should be URL-encoded if it contains special characters
    example{{location}}

Responses

200Successful response
object
codeinteger

HTTP status code of the response

example200
  • must be a valid HTTP status code (100-599)
  • required
dataarray
errorsobject
messagestring

Status message describing the outcome of the list nodes request.

exampleSuccess
  • Must be a non-empty string
  • Typically limited to a short length (e.g., ≤255 characters)