Skip to main content
POST
/
core.v1.ResourceService
/
ListResources
cURL
curl -X POST "https://api.joinformal.com/core.v1.ResourceService/ListResources" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "resources": [
    {
      "id": "<string>",
      "name": "<string>",
      "technology": "ssh",
      "hostname": "<string>",
      "port": 123,
      "environment": "<string>",
      "terminationProtection": true,
      "spaceId": "<string>",
      "space": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "terminationProtection": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "provider": "",
      "tags": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "listMetadata": {
    "after": "<string>",
    "before": "<string>",
    "count": 123,
    "nextCursor": "<string>"
  }
}

Authorizations

X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json
limit
integer<int32>
Required range: x <= 500
cursor
string
order
string
searchFields
enum<string>[]
Available options:
name,
hostname,
port,
technology,
environment
filter
filter · object
spaceId
string | null

Response

Success

resources
Resource · object[]
listMetadata
list_metadata · object