List custom forms

GET

custom_forms

List custom forms

curl --request GET \
  --url https://api.rootly.com/v1/custom_forms \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "custom_forms",
      "attributes": {
        "name": "<string>",
        "enabled": true,
        "command": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "slug": "<string>",
        "description": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  },
  "meta": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123,
    "next_cursor": "<string>"
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[number]

integer

page[size]

integer

filter[search]

string

filter[name]

string

filter[slug]

string

filter[command]

string

filter[created_at][gt]

string

filter[created_at][gte]

string

filter[created_at][lt]

string

filter[created_at][lte]

string

sort

string

Response

custom_form found

data

object[]

required

Show child attributes

links

object

required

Show child attributes

meta

object

required

Show child attributes

included

object[]

Show child attributes

Creates a custom formCreates a new custom form from provided data

⌘I

List custom forms

curl --request GET \
  --url https://api.rootly.com/v1/custom_forms \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "custom_forms",
      "attributes": {
        "name": "<string>",
        "enabled": true,
        "command": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "slug": "<string>",
        "description": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  },
  "meta": {
    "current_page": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123,
    "total_pages": 123,
    "next_cursor": "<string>"
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}