Skip to content
All’s Well
API reference

Projects

Last updated MarkdownOpenAPI 3.1

A project groups one client's monitors, servers, sites and status pages inside a team, so an agency can see and manage each client on its own. Each item is in at most one project, or none. The REST API reads and creates projects, and puts monitors in them: see project on monitors. The MCP server also renames projects and moves servers, sites and status pages.

The project object

Field Type Description
key string A short name made from the project's first name, such as acme-ltd. It never changes, even if the project is renamed, so scripts can rely on it.
name string The name shown in the dashboard. Unique in the team, ignoring case. Up to 100 characters.
created_at string When the project was created, in UTC.

Anywhere a request takes a project, send the key or the name. The key is safer, because a name can change. In alls-well.json keep the name you first used: it is also the start of every monitor's name.

List projects

GET /api/v1/projects

Lists the team's projects in name order. Not paginated. With match, it returns only the project whose key or name is that text, or a name it had before a rename, which is a list of one, or an empty list when there is none.

Authentication Bearer token. Any member of the team
Rate limit 60 requests per minute per user, shared by all of that user's tokens

Parameters

Name In Type Required Description
match query string No A project's key or name. Up to 255 characters.

Example request

curl https://alls-well.io/api/v1/projects \
  -H "Authorization: Bearer $ALLS_WELL_TOKEN" \
  -H "Accept: application/json"

Responses

Status When Body
200 The team's projects. A list of projects, wrapped in data
401 There is no token, or it is invalid or revoked. Problem
403 The token is valid but may not do this: a Viewer tried to change something, the token isn't pinned to a team, or its creator has left the team. Problem
422 The request body or query is invalid. errors lists the messages for each field. Validation problem
429 The rate limit is used up. Wait for Retry-After seconds. Problem
500 Something went wrong on our side. Try again; if it persists, contact support. Problem

200

{
  "data": [
    {
      "key": "acme-ltd",
      "name": "Acme Ltd",
      "created_at": "2026-11-14T09:30:00.000000Z"
    }
  ]
}

401

{"type": "about:blank", "title": "Unauthorized", "status": 401}

403

{"type": "about:blank", "title": "Forbidden", "status": 403}

422

{
  "type": "https://alls-well.io/docs/api/problems/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "The match field must be a string.",
  "errors": {
    "match": ["The match field must be a string."]
  }
}

429

{"type": "about:blank", "title": "Too Many Requests", "status": 429}

500

{"type": "about:blank", "title": "Internal Server Error", "status": 500}

Create a project

POST /api/v1/projects

Creates a project. Its key is made from the name and never changes. A name that makes no key, such as !!!, or that makes the key of another project, such as acme! when Acme exists, is refused. So is a name another project had before a rename. To reuse a project that may exist, look it up with match first: a name that exists is refused.

Authentication Bearer token. Owners and Admins only; Viewers get 403
Rate limit 60 requests per minute per user, shared by all of that user's tokens

Request body

Field Type Required Rules
name string Yes The project's name. Up to 100 characters, with a letter or number in it, and not the name, earlier name or key of another project in the team.

Example request

curl -X POST https://alls-well.io/api/v1/projects \
  -H "Authorization: Bearer $ALLS_WELL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Acme Ltd"}'

Responses

Status When Body
201 The project was created. Location is the list filtered to it. The project, wrapped in data
401 There is no token, or it is invalid or revoked. Problem
402 The team already has as many projects as its plan allows. Project limit problem
403 The token is valid but may not do this: a Viewer tried to change something, the token isn't pinned to a team, or its creator has left the team. Problem
422 The request body or query is invalid. errors lists the messages for each field. Validation problem
429 The rate limit is used up. Wait for Retry-After seconds. Problem
500 Something went wrong on our side. Try again; if it persists, contact support. Problem

201

{
  "data": {
    "key": "acme-ltd",
    "name": "Acme Ltd",
    "created_at": "2026-11-14T09:30:00.000000Z"
  }
}

401

{"type": "about:blank", "title": "Unauthorized", "status": 401}

402

{
  "type": "https://alls-well.io/docs/api/problems/project-limit-reached",
  "title": "Project limit reached",
  "status": 402,
  "detail": "The Free plan allows 2 projects and this team has 2. Delete a project or upgrade the plan.",
  "plan": "free",
  "max_projects": 2
}

403

{"type": "about:blank", "title": "Forbidden", "status": 403}

422

{
  "type": "https://alls-well.io/docs/api/problems/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "There's already a project called Acme Ltd.",
  "errors": {
    "name": ["There's already a project called Acme Ltd."]
  }
}

429

{"type": "about:blank", "title": "Too Many Requests", "status": 429}

500

{"type": "about:blank", "title": "Internal Server Error", "status": 500}