For the complete documentation index, see llms.txt. This page is also available as Markdown.

Access Groups

Access Groups endpoints

List all access groups

get
/status_pages/{subdomain}/access_groups
Authorizations
AuthorizationstringRequired
Path parameters
subdomainstringRequired

The subdomain of your status page.

You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).

Responses
200

The list of access groups

application/json
get/status_pages/{subdomain}/access_groups
GET /api/v2/status_pages/{subdomain}/access_groups HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "access_groups": [
    {
      "id": 3,
      "name": "name",
      "service_ids": [
        1
      ],
      "users_status_pages": [
        1
      ]
    }
  ]
}

Adds a new access group

post
/status_pages/{subdomain}/access_groups
Authorizations
AuthorizationstringRequired
Path parameters
subdomainstringRequired

The subdomain of your status page.

You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).

Body
Responses
200

The access group was created

application/json
post/status_pages/{subdomain}/access_groups
POST /api/v2/status_pages/{subdomain}/access_groups HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "access_group": {
    "name": "name",
    "service_ids": [
      1
    ],
    "users_status_pages": [
      1
    ]
  }
}
{
  "access_group": {
    "id": 3,
    "name": "name",
    "service_ids": [
      1
    ],
    "users_status_pages": [
      1
    ]
  }
}

Get an access group

get
/status_pages/{subdomain}/access_groups/{accessGroupId}
Authorizations
AuthorizationstringRequired
Path parameters
subdomainstringRequired

The subdomain of your status page.

You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).

accessGroupIdintegerRequired

The ID of an access group

Responses
200

The access group

application/json
get/status_pages/{subdomain}/access_groups/{accessGroupId}
GET /api/v2/status_pages/{subdomain}/access_groups/{accessGroupId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "access_group": {
    "id": 3,
    "name": "name",
    "service_ids": [
      1
    ],
    "users_status_pages": [
      1
    ]
  }
}

Update the access group

put
/status_pages/{subdomain}/access_groups/{accessGroupId}
Authorizations
AuthorizationstringRequired
Path parameters
subdomainstringRequired

The subdomain of your status page.

You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).

accessGroupIdintegerRequired

The ID of an access group

Body
Responses
200

The access group was updated

application/json
put/status_pages/{subdomain}/access_groups/{accessGroupId}
PUT /api/v2/status_pages/{subdomain}/access_groups/{accessGroupId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "access_group": {
    "name": "name",
    "service_ids": [
      1
    ],
    "users_status_pages": [
      1
    ]
  }
}
{
  "access_group": {
    "id": 3,
    "name": "name",
    "service_ids": [
      1
    ],
    "users_status_pages": [
      1
    ]
  }
}

Deletes the access group

delete
/status_pages/{subdomain}/access_groups/{accessGroupId}
Authorizations
AuthorizationstringRequired
Path parameters
subdomainstringRequired

The subdomain of your status page.

You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).

accessGroupIdintegerRequired

The ID of an access group

Responses
204

Access group deleted successfully

delete/status_pages/{subdomain}/access_groups/{accessGroupId}
DELETE /api/v2/status_pages/{subdomain}/access_groups/{accessGroupId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*

No content

Last updated