{
  "info": {
    "_postman_id": "8e3c1d52-4b7a-4f0e-a6d9-2c51f7b8e403",
    "name": "Orbits API",
    "description": "Every endpoint of the Orbits API (https://docs.orbits.africa/api).\n\n1. Set the collection variable `apiKey` to an API token from the dashboard (Team › Settings › API tokens). Keep it in the Current value so it is not synced.\n2. Send **Teams and account → Current user** to check it.\n\nPOSTs that take one send a fresh `Idempotency-Key` ({{$guid}}). Slugs and ids in the example URLs are placeholders: replace them with your own.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{apiKey}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.theorbits.app/v1",
      "type": "string"
    },
    {
      "key": "apiKey",
      "value": "",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Teams and account",
      "description": "Call `GET /v1/me` first: it confirms the token works and lists the one team (and project, for a project-limited token) it reaches. Every other route is under `/v1/teams/{team}`, where `{team}` is the team's slug or its `team_` id. Members, invites, tokens and the team's security rules are managed in the dashboard: an API token can't reach them (see [Authentication](/api/authentication)).",
      "item": [
        {
          "name": "Current user",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/me",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "me"
              ]
            },
            "description": "Current user, with their teams and each team's newest projects, so the app can render its shell from one call.\n\nDocs: https://docs.orbits.africa/api/teams#current-user"
          },
          "response": []
        },
        {
          "name": "Teams the caller belongs to",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ]
            },
            "description": "Teams the caller belongs to.\n\nDocs: https://docs.orbits.africa/api/teams#teams-the-caller-belongs-to"
          },
          "response": []
        },
        {
          "name": "Get a team",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "Get a team.\n\nDocs: https://docs.orbits.africa/api/teams#get-a-team"
          },
          "response": []
        },
        {
          "name": "Rename, change slug, avatar, default region, or security rules",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"My Team\",\n  \"slug\": \"my-app\",\n  \"avatar_url\": \"https://my-app.theorbits.app\",\n  \"default_region\": \"abj-1\",\n  \"require_two_factor\": false,\n  \"session_max_age_days\": 1,\n  \"inviters\": \"owners\",\n  \"sign_in_methods\": [\n    \"email\"\n  ],\n  \"notifications\": {}\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Rename, change slug, avatar, default region, or security rules.\n\nChanging the slug breaks old dashboard links. All settings require an owner or admin.\n\nDocs: https://docs.orbits.africa/api/teams#rename-change-slug-avatar-default-region-or-security-rules"
          },
          "response": []
        },
        {
          "name": "Dashboard overview for a time range",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/overview",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "overview"
              ],
              "query": [
                {
                  "key": "range",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "Dashboard overview for a time range, worked out when asked. `deployments.total` counts deployments started in the range, and `delta_vs_previous` compares it with the range before (the 24 hours, 7 or 30 days before that). `average_build_seconds` is the mean build of those that went ready, 0 when none did. `requests.total` counts requests to any of the team's deployments, production and previews, in the range; `month_to_date` since midnight on the 1st in Lagos. Both are 0 while the log store can't be reached. `projects.failing` and `needs_attention` are the projects whose latest deployment failed. `series` cuts the range into equal slices, oldest first (7 for `24h` and `7d`, 4 for `30d`), and gives each one's deployments, average ready build (0 when none) and requests, so `series.deployments` adds up to `deployments.total`.\n\nDocs: https://docs.orbits.africa/api/teams#dashboard-overview-for-a-time-range"
          },
          "response": []
        },
        {
          "name": "Notifications for the caller in this team",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/notifications",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "notifications"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "unread",
                  "value": "",
                  "description": "Only the ones the caller hasn't read.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "The top bar's notifications: the team activity lines worth a nudge, newest first, with whether the caller has read each. They are a failed deployment (`deployment.failed`), a domain going live (`domain.live`) or stopping pointing at Orbits (`domain.misconfigured`), a certificate that couldn't be issued or isn't renewing (`domain.certificate.failed`), a member joining (`team.member.added`, but not the caller's own) and an alert firing (`alert.fired`). The list goes back 30 days, and no further than when the caller joined the team. `unread_count` counts the unread ones, up to 100, whatever the page.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/teams#notifications-for-the-caller-in-this-team"
          },
          "response": []
        },
        {
          "name": "Mark notifications read",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/notifications",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "notifications"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"ids\": [\n    \"ids\"\n  ],\n  \"all\": false\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Marks notifications read for the caller only. Send `ids` (from `GET /v1/teams/{team}/notifications`) for some, or `all: true` for every one up to now; with `all`, `ids` is ignored. Ids of another team's notifications are ignored.\n\n**Permissions:** Any team member, for their own notifications. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/teams#mark-notifications-read"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Projects",
      "description": "A project is one app: its source (a Git repository, or uploads), how it builds, and its addresses. Its `slug` is unique across Orbits, because it is the free address `<slug>.theorbits.app`; renaming a project changes it. `{project}` in a path is the slug or the `prj_` id. See [Projects](/deploy/projects) for the guide.",
      "item": [
        {
          "name": "Starter templates for a new project",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/templates",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "templates"
              ]
            },
            "description": "The \"Start from a template\" catalog on the New project screens, read from [the-orbits/templates](https://github.com/the-orbits/templates) (its `catalog.json`, cached for five minutes). A template added there appears here without a backend change.\n\n`workload` and `node_version`, when present, are what a project created from the template gets; `optional_env` lists variables the template reads when they are set. If the templates repository cannot be reached and nothing is cached, the list built into the service is served instead.\n\n**Permissions:** Any signed-in user.\n\nDocs: https://docs.orbits.africa/api/projects#starter-templates-for-a-new-project"
          },
          "response": []
        },
        {
          "name": "List projects",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "q",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "sort",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "repository",
                  "value": "",
                  "description": "Only projects imported from this repository, e.g. `shadyventures/storefront`.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "The projects of a team, for the project cards on the team overview and for the project switcher.\n\nFields that come from deployments (`status`, `latest_deployment`, `thumbnail_url`) are `pending` or null until the deployment pipeline exists. Paused projects report `status: paused`.\n\nSorting: `last_deploy` (default) puts the most recently deployed first, then projects with no deployment by `created_at`.\n\nAn API token limited to one project may call this too: the list then holds only that project (still subject to `q` and `repository`), with `next_cursor: null`.\n\n**Permissions:** Any team member, including viewers. A non-member gets 404, the same as an unknown team.\n\nDocs: https://docs.orbits.africa/api/projects#list-projects"
          },
          "response": []
        },
        {
          "name": "Create a project from a repository or a template",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"my-app\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Create a project: the Deploy button on the New project > Configure screens.\n\n`name` becomes the free address, `<slug>.theorbits.app`, where `slug` is the name in lower case with hyphens (or the `slug` you send). It must be unique across all teams: 409 means ask for another name.\n\n`workload` is optional. When omitted it is derived from `build.framework`: `nextjs`, `sveltekit`, `nuxt`, `remix`, `reactrouter`, `solidstart` and `tanstack-start` become a `function`, `node`, `elysia` and `dolphjs` an `app`, and everything else `static`.\n\nFor a GitHub `source`, Orbits asks the Git service whether the team's GitHub connection can see the repository. 422 with `source.repository` means it cannot (not found, or not installed on that repository); 422 with `source.provider` means GitHub is not connected to the team. If that check cannot be completed the answer is 503 and nothing is created; retry.\n\nWith a `template` instead, Orbits creates a private repository named after the project's slug in the team's connected GitHub account, commits the template's files into it, and creates the project from it with the template's `workload` and `node_version`; the first deployment is queued as for an import. Every variable in the template's `required_env` must be sent in `env` (422 on `env` otherwise), and the address must be free before the repository is created. In a personal GitHub account the caller must have approved Orbits first (`GET /v1/teams/{team}/integrations/github/approval`). 409 covers a taken address, a repository of that name already in the account, GitHub not connected, a personal account not yet approved, and an organisation whose installation has not yet accepted the Orbits app's Administration and Contents permissions; its `detail` says which. 503 means GitHub could not be reached.\n\n**Permissions:** Owner, admin or member of the team. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/projects#create-a-project-from-a-repository-or-a-template"
          },
          "response": []
        },
        {
          "name": "Get a project",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "One project, for the project overview header and for the Settings form.\n\n**Permissions:** Any team member. A non-member, or a project in another team, gets 404.\n\nDocs: https://docs.orbits.africa/api/projects#get-a-project"
          },
          "response": []
        },
        {
          "name": "Change project settings",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"my-app\",\n  \"workload\": {\n    \"type\": \"static\",\n    \"output_directory\": \"dist\",\n    \"spa_fallback\": false\n  },\n  \"source\": {\n    \"provider\": \"github\",\n    \"repository\": \"shadyventures/storefront\",\n    \"production_branch\": \"main\",\n    \"root_directory\": \"./\"\n  },\n  \"build\": {\n    \"framework\": null,\n    \"install_command\": null,\n    \"build_command\": null,\n    \"output_directory\": null,\n    \"ignore_command\": null,\n    \"changed_by\": {\n      \"id\": \"id\",\n      \"name\": \"my-app\"\n    },\n    \"changed_at\": \"2026-11-10T09:30:00Z\"\n  },\n  \"git\": {\n    \"deploy_on_push\": false,\n    \"preview_pull_requests\": false,\n    \"comment_on_pull_requests\": false\n  },\n  \"node_version\": \"22.x\",\n  \"preview_protection\": \"none\",\n  \"preview_password\": \"preview-password\",\n  \"region\": \"region\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Change project settings. Settings save as the user makes them (the Settings screen shows \"All changes saved\"), so send only the fields that changed.\n\nChanges apply from the next deployment; existing deployments keep the snapshot taken when they were built. Renaming (`name`) also changes `slug` and the free address. The workload type cannot change after creation (422).\n\n`build` and `git` are merged field by field: omit a field to keep it, send `null` in `build` to go back to the detected default. `preview_password` is write-only and only valid with `preview_protection: password`.\n\n**Permissions:** Owner or admin. Members and viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/projects#change-project-settings"
          },
          "response": []
        },
        {
          "name": "Delete a project",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "Delete a project (Settings > Delete project). The record is removed and an Operation is returned; downstream cleanup will be tracked by the same Operation once those services exist.\n\n**Permissions:** Owner or admin. Members and viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/projects#delete-a-project"
          },
          "response": []
        },
        {
          "name": "What deleting a project removes",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/deletion-impact",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "deletion-impact"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "The numbers on the Delete modal: \"126 deployments and their build logs, 11 environment variables, 5 flags and their history, 4 domains are detached\".\n\n**Permissions:** Owner or admin, like the delete itself. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/projects#what-deleting-a-project-removes"
          },
          "response": []
        },
        {
          "name": "Pause or resume a project",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/pause",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "pause"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"paused\": false\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Pause or resume a project (the Paused toggle in Settings > Advanced). While paused, its production, preview and custom-domain addresses answer 503 with Orbits' paused page, its apps stop, and nothing deploys; domains, data and the builds production can come back to stay. Resuming serves production again within moments.\n\nThe response is the updated Project (`paused` and `status: paused`), not an Operation: the toggle needs an immediate answer, and the runtime effect is reported through `status`.\n\n**Permissions:** Owner or admin. Members and viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/projects#pause-or-resume-a-project"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Deployments",
      "description": "A deployment is one build of a project, immutable once built. A push to a connected repository creates one by itself; `POST .../deployments` builds a branch's newest commit, and a project with `source_kind: upload` deploys from a zip you upload. Creating one answers `202` with the new deployment: poll it, or follow its build log stream, until its `state` is `ready`, `failed` or `canceled`. Promoting, rolling back and setting production move a pointer. See [Deployments](/deploy/deployments).",
      "item": [
        {
          "name": "Deployments across the team's projects",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/deployments",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "deployments"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "q",
                  "value": "",
                  "description": "Matches the commit message, branch, sha or author.",
                  "disabled": true
                },
                {
                  "key": "project",
                  "value": "",
                  "description": "Project slug or `prj_` id.",
                  "disabled": true
                },
                {
                  "key": "environment",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "state",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "author",
                  "value": "",
                  "description": "An `authors[].name`.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "The team's Deployments page: every deployment across its projects, newest first, with the facets for its filters (Project, Environment, Status, Author) and \"38 this week\".\n\nAn API token limited to one project may call this too: the deployments, `projects`, `authors`, `total` and `this_week` then cover only that project, and a `project` filter naming another project returns an empty list.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#deployments-across-the-teams-projects"
          },
          "response": []
        },
        {
          "name": "A project's deployments",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/deployments",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "deployments"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "q",
                  "value": "",
                  "description": "Matches the commit message, branch, sha or author.",
                  "disabled": true
                },
                {
                  "key": "environment",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "state",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "branch",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "live",
                  "value": "",
                  "description": "Only deployments that have served production.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "The project's Deployments page: every build, newest first, with the filters (search, Env, Status, Branch, \"Production only\") and what the inspector shows when nothing is picked (`current`, the deployment production serves, and its `domains`).\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#a-projects-deployments"
          },
          "response": []
        },
        {
          "name": "Deploy a branch now",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/deployments",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "deployments"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"branch\": \"main\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Queues a build of a branch's newest commit, for a deploy started by hand (the CLI's `orbits deploy`). The production branch deploys to production; any other branch to preview. Pushes and the first deploy of a new project are queued by Orbits itself and need no call. Returns at once with the queued deployment; follow it with `GET .../deployments/{deployment}` and its logs.\n\n**Permissions:** Owner, admin or member. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#deploy-a-branch-now"
          },
          "response": []
        },
        {
          "name": "Start dropping a site or app",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/uploads",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "uploads"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"size\": 1\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "The drag and drop deploy: the person drops a folder (or a `.zip`) on the project, and the browser sends it to storage on a presigned URL, so the files never pass through the API. The archive is the project's **source code**, in place of a Git clone: Orbits unpacks it, detects the framework, installs, builds and publishes or runs it like any other deployment, for any kind of project. Only projects created with `source_kind: upload` take drops.\n\nWhat goes in the archive: the project's files, with `package.json`, source and config. Anything named `node_modules`, `.git`, `.next`, `__MACOSX` or `.DS_Store`, at any depth, is left out, and a single top-level folder is stripped, so zipping the folder or its contents both work. Limits: the zip may be up to `max_bytes` (100 MiB, 104,857,600 bytes); unpacked it may be up to 500 MiB and 20,000 entries, where the folders the zip lists count as well as its files (what is left out doesn't count); links and special files are refused. The build reports a breach on the Cloning step.\n\nStarting signs a PUT URL for the zip (valid ten minutes). At most 5 unfinished uploads per team.\n\n**Permissions:** Owner, admin or member. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#start-dropping-a-site-or-app"
          },
          "response": []
        },
        {
          "name": "Deploy a dropped archive",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/uploads/:upload/complete",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "uploads",
                ":upload",
                "complete"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "upload",
                  "value": "upl_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": "The `id` from `POST .../uploads`."
                }
              ]
            },
            "description": "Say the browser has sent the zip. Orbits checks that it arrived whole and is a zip, then queues a production deployment that builds it (`trigger: manual`, the message is `Uploaded <filename>`). Returns at once; follow the deployment and its logs as for any build. The archive is kept, with the project's four previous ones, so Redeploy can rebuild it.\n\nIf the file hasn't arrived yet this is 409 `upload_incomplete`: wait a second and call again. Completing an upload twice returns the same deployment.\n\n**Permissions:** Owner, admin or member. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#deploy-a-dropped-archive"
          },
          "response": []
        },
        {
          "name": "Cancel a drop",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/uploads/:upload",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "uploads",
                ":upload"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "upload",
                  "value": "upl_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": "The `id` from `POST .../uploads`."
                }
              ]
            },
            "description": "Abandons an upload that was started and not completed; the file, if it arrived, is removed. Cancelling one that is gone or already completed is a no-op (the deployment it made is unaffected). Not needed for an upload that simply expires.\n\n**Permissions:** Owner, admin or member. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#cancel-a-drop"
          },
          "response": []
        },
        {
          "name": "Set what production serves",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/production",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "production"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"deployment_id\": \"dpl_01jc8x6e4mq2v7r9y3t5b0zp8w\",\n  \"auto_deploy_paused\": false\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Points production at a deployment that served production before, and sets whether pushes may replace it. It is the Undo of a rollback (send back the rollback answer's `undo`), and with the current deployment and `auto_deploy_paused: false` it lifts a rollback's pause. No rebuild.\n\n**Permissions:** Owner, admin or member. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#set-what-production-serves"
          },
          "response": []
        },
        {
          "name": "A deployment and its build steps",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/deployments/:deployment",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "deployments",
                ":deployment"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "deployment",
                  "value": "dpl_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "description": "The deployment page and the inspector: the header, the details grid (status, environment, duration, created, branch, commit, region, framework), production's domains when it is the current deployment, the six build steps with their state and seconds, and why a failed build stopped. The log lines themselves come from `GET .../logs`.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#a-deployment-and-its-build-steps"
          },
          "response": []
        },
        {
          "name": "Build log lines",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/deployments/:deployment/logs",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "deployments",
                ":deployment",
                "logs"
              ],
              "query": [
                {
                  "key": "after",
                  "value": "",
                  "description": "Return lines after this `n`.",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "deployment",
                  "value": "dpl_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "description": "The build log, oldest line first. Each line names its step, so the deployment page can group lines under Queued, Cloning repository, Installing packages, Building, Uploading and Going live. A build keeps at most 5000 lines.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#build-log-lines"
          },
          "response": []
        },
        {
          "name": "Follow a build live (server-sent events)",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/deployments/:deployment/logs/stream",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "deployments",
                ":deployment",
                "logs",
                "stream"
              ],
              "query": [
                {
                  "key": "after",
                  "value": "",
                  "description": "The same as Last-Event-ID, for a first connection that already has lines.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "deployment",
                  "value": "dpl_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "description": "The live build log, pushed as server-sent events (`text/event-stream`), for New project · Deploying, a building deployment and Follow output. Lines arrive under a second after the build prints them. Events:\n\n- `line` (its `id` is the line's `n`): `{\"n\", \"at\", \"step\", \"tone\", \"text\"}`, oldest first.\n- `steps`: the six steps, as in the deployment's `steps`, whenever one changes.\n- `done`: `{\"state\", \"failure\", \"duration_seconds\"}` once the build has ended and every line has been sent. The stream then closes, unless the deployment just went ready.\n- `screenshot`: `{\"screenshot_url\"}`, the same URL the deployment's `screenshot_url` gives. The builder takes the screenshot a few seconds after the deployment is ready, so after `done` the stream stays open for up to 2 minutes and sends this when it is saved, then closes. Refresh the deployment (or its thumbnail) on it. It is not sent for a failed or canceled build, a worker, a deployment that already had its screenshot, or one that finished more than 2 minutes ago.\n- A `: keep-alive` comment every 15 s while nothing happens.\n\nThe stream closes after 30 minutes or when a proxy cuts it (staging's after 5); reconnect with `Last-Event-ID` set to the last line `id` received (EventSource does this by itself) and it carries on with the next line, without gaps or repeats. A finished deployment answers with any remaining lines, its steps and `done` at once.\n\n**Permissions:** Any team member. A non-member gets 404 (a problem document, not a stream).\n\nDocs: https://docs.orbits.africa/api/deployments#follow-a-build-live-server-sent-events"
          },
          "response": []
        },
        {
          "name": "A deployment's screenshot",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/deployments/:deployment/screenshot",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "deployments",
                ":deployment",
                "screenshot"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "deployment",
                  "value": "dpl_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "description": "The image for the deployment inspector, the deployment page, New project's Preview box and the project card: the first screen (1280x800) of the deployment's home page, as a JPEG, taken by the builder a few seconds after the deployment became ready. It never changes once taken, so it is sent with `Cache-Control: private, max-age=604800, immutable`.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#a-deployments-screenshot"
          },
          "response": []
        },
        {
          "name": "Build the same commit again",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/deployments/:deployment/redeploy",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "deployments",
                ":deployment",
                "redeploy"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "deployment",
                  "value": "dpl_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"use_cache\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "The Redeploy modal: builds this deployment's commit again in the same environment, as a new deployment. A production redeploy takes over production when it is ready; until then production keeps serving the current build. A deployment that failed before its commit was known rebuilds its branch's newest commit. A dropped upload is rebuilt from its stored archive; only the project's last 5 are kept, and an older one is 409 `source_expired` (drop the site again).\n\n**Permissions:** Owner, admin or member. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#build-the-same-commit-again"
          },
          "response": []
        },
        {
          "name": "Promote to production",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/deployments/:deployment/promote",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "deployments",
                ":deployment",
                "promote"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "deployment",
                  "value": "dpl_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "description": "The Promote modal: rebuilds a ready deployment's commit with production's environment variables, as a new production deployment that goes live when it is ready. The current version stays live until then. Promoting also lifts a rollback's pause on auto-deploy.\n\n**Permissions:** Owner, admin or member. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#promote-to-production"
          },
          "response": []
        },
        {
          "name": "Roll production back",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/deployments/:deployment/rollback",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "deployments",
                ":deployment",
                "rollback"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "deployment",
                  "value": "dpl_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "description": "Points production at an earlier production build straight away, with no rebuild, and pauses auto-deploy so the next push does not replace it (pushes still build; they just do not go live). The answer's `undo` restores what production served before, through `POST .../projects/{project}/production`.\n\n**Permissions:** Owner, admin or member. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#roll-production-back"
          },
          "response": []
        },
        {
          "name": "Cancel a build",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/deployments/:deployment/cancel",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "deployments",
                ":deployment",
                "cancel"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "deployment",
                  "value": "dpl_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "description": "\"Cancel deployment\": a queued deployment is canceled at once; a building one is stopped by its builder within a few seconds (the answer still says `building`; poll until it says `canceled`). Nothing it built goes live.\n\n**Permissions:** Owner, admin or member. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/deployments#cancel-a-build"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Environment variables",
      "description": "Each variable is a key with a value for one or more environments (`production`, `preview`, `development`). Values are encrypted at rest and never returned by a list: reveal one, or pull an environment's, with a `full` token. A `read` token never reads values. A change applies to deployments created after it: redeploy to use it. See [Environment variables](/deploy/environment-variables).",
      "item": [
        {
          "name": "List variables",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/env",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "env"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "environment",
                  "value": "",
                  "description": "Only variables that apply to this environment.",
                  "disabled": true
                },
                {
                  "key": "q",
                  "value": "",
                  "description": "Substring of the key.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "The Environment variables page: one row per `key`, with the environments it applies to. Values are encrypted at rest. A row's `value` is returned only for a variable that is not `sensitive` and whose key is meant for the browser (it starts with `NEXT_PUBLIC_`, `NUXT_PUBLIC_`, `PUBLIC_`, `VITE_`, `REACT_APP_` or `EXPO_PUBLIC_`, or ends with `_PUBLIC_KEY`); every other `value` is `null` and the page shows dots. A `sensitive` variable can never be read back by anyone (the dialog says \"Nobody can read it back, only replace it\"), so show no eye icon, Reveal value or Copy value for it. For any other variable, \"Reveal value\" and \"Copy value\" call `POST /v1/teams/{team}/projects/{project}/env/{key}/reveal`.\n\n`total` is the number of variables that match the filters (\"10 variables\"). `last_changed` feeds the pull dialog (\"Last changed yesterday by Shady Asaolu\"); it is `null` when there are none. `redeploy` drives the blue banner (\"You changed 1 variable. Redeploy so production picks it up.\"): `required` is true when something changed since the project's latest deployment and `changed` counts those variables; each row's `pending_redeploy` marks the ones to highlight (the \"New\" tag). Until deployments exist, `redeploy.required` is always false.\n\n**Permissions:** Any team member, including viewers. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/environment-variables#list-variables"
          },
          "response": []
        },
        {
          "name": "Add variables, or import a .env file",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/env",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "env"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"variables\": [\n    {\n      \"key\": \"STRIPE_SECRET_KEY\",\n      \"value\": \"value\",\n      \"environments\": [\n        \"production\"\n      ],\n      \"sensitive\": true\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Saves one or more variables. The Add variable dialog sends one with the default `on_conflict: fail`: a key that already exists is 409 and nothing is saved (use Edit instead). The Import .env dialog sends every parsed line with `on_conflict: replace`, which replaces the value and environments of keys that already exist, as its warning says (\"Importing replaces its value in the environments you pick\"). The dialog parses the file in the browser; show the conflicts from the list you already loaded. `sensitive` defaults to true, as the Sensitive checkbox does.\n\nA project can have at most 1,000 variables. An import that would go over (replacing existing keys adds none) is 422 on `variables` and saves nothing. The request body is at most 1 MiB, which the gateway enforces on every request (413), so a very large import must be split.\n\nThe new values apply to deployments created afterwards; `redeploy_required` says whether the banner should show.\n\n**Permissions:** Owner, admin or member of the team. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/environment-variables#add-variables-or-import-a-env-file"
          },
          "response": []
        },
        {
          "name": "Change a value or its environments",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/env/:key",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "env",
                ":key"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "key",
                  "value": "DATABASE_URL",
                  "description": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"value\": \"value\",\n  \"environments\": [\n    \"production\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "The Edit dialog: the key is read-only (\"To rename a key, add a new one and delete this one\"). Send `value` only when the user typed a new one; leave it out to change just the environments. Send `environments` only when the checkboxes changed. At least one of them is required. Whether a variable is `sensitive` cannot be changed here.\n\n**Permissions:** Owner, admin or member of the team. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/environment-variables#change-a-value-or-its-environments"
          },
          "response": []
        },
        {
          "name": "Delete a variable",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/env/:key",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "env",
                ":key"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "key",
                  "value": "DATABASE_URL",
                  "description": ""
                }
              ]
            },
            "description": "The Delete dialog (\"Type STRIPE_SECRET_KEY to confirm\"; the typed confirmation is checked in the browser). The variable is hidden at once but its encrypted value is kept until `restorable_until` (10 minutes), so the toast's Undo can call `POST /v1/teams/{team}/projects/{project}/env/{key}/restore`. Deployments created after the delete no longer get it.\n\n**Permissions:** Owner, admin or member of the team. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/environment-variables#delete-a-variable"
          },
          "response": []
        },
        {
          "name": "Undo a delete",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/env/:key/restore",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "env",
                ":key",
                "restore"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "key",
                  "value": "DATABASE_URL",
                  "description": ""
                }
              ]
            },
            "description": "The Undo button on the \"deleted\" toast. It brings the variable back with the value and environments it had. 404 means the 10 minutes have passed (or it was never deleted); 409 means a variable with that key exists again.\n\n**Permissions:** Owner, admin or member of the team. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/environment-variables#undo-a-delete"
          },
          "response": []
        },
        {
          "name": "Reveal a value",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/env/:key/reveal",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "env",
                ":key",
                "reveal"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "key",
                  "value": "DATABASE_URL",
                  "description": ""
                }
              ]
            },
            "description": "\"Reveal value\" and \"Copy value\" (and the eye icon) on a row. It is a POST because every reveal is recorded as a `project.env.revealed` event with who asked and which key, never the value. A `sensitive` variable answers 409: it can never be read back. The response is never cached or replayed: this call ignores `Idempotency-Key`, so every call reads the value again and is recorded.\n\n**Permissions:** Owner, admin or member of the team. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/environment-variables#reveal-a-value"
          },
          "response": []
        },
        {
          "name": "Download values for local development (`orbits env pull`)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/env/pull",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "env",
                "pull"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"environment\": \"production\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "What `orbits env pull` calls to write `.env.local`. It returns the values of every variable that applies to `environment`, except `sensitive` ones, which nobody can read back: their keys are listed in `skipped_sensitive` so the CLI can tell the user. Every pull is recorded as a `project.env.pulled` event. The response is never cached or replayed: this call ignores `Idempotency-Key`, so every call reads the values again and is recorded. The dashboard only shows the pull dialog; it does not call this endpoint.\n\n**Permissions:** Owner, admin or member of the team. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/environment-variables#download-values-for-local-development-orbits-env-pull"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Domains",
      "description": "A domain belongs to the team and points at one project (and optionally one branch, or a redirect). Add it, then point it at Orbits the way its `dns_mode` says: one record at your DNS provider, or Orbits DNS by changing the domain's nameservers. Orbits checks the records and issues the certificate itself. See [Custom domains](/domains/custom-domains).",
      "item": [
        {
          "name": "A project's branch addresses",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/branch-addresses",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "branch-addresses"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "The branch rows on a project's Domains page (\"Follows the branch\"): one address per branch with a ready preview, serving that branch's newest ready preview. The address is `<project>-git-<branch>.theorbits.app` (`orders-git-feat-apple-pay.theorbits.app`), one label under the free addresses' domain so their certificate covers it; a long branch is shortened and given a short hash. Show `host` as it is rather than building it.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/domains#a-projects-branch-addresses"
          },
          "response": []
        },
        {
          "name": "The team's domains",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains"
              ],
              "query": [
                {
                  "key": "q",
                  "value": "",
                  "description": "Part of a domain's name or its project's name.",
                  "disabled": true
                },
                {
                  "key": "state",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "dns",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "project",
                  "value": "",
                  "description": "A project's `id` or `slug`.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "The team's Domains and DNS page: every domain the team added, newest first, with the page's counts and the projects for its filter. A project's Domains page is this list with `project` set. Teams have a handful of domains, so the list isn't paged.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/domains#the-teams-domains"
          },
          "response": []
        },
        {
          "name": "Add a domain",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"domain\": \"shop.shadyventures.ng\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "The Add domain dialog, on the team's Domains and DNS page or a project's Domains page. The domain starts `pending`. With `dns: external`, show `required_record` for the team to add at its DNS provider. With `dns: orbits`, the domain becomes a zone of its own: show `nameservers.names` for the team to set at its registrar (an apex, `host: \"@\"`) or to add as NS records for that name at its parent's DNS (a subdomain such as `dns-test.example.com`); Orbits then serves the whole zone, keeps the records its projects need, and the team manages the rest (`.../records`). A name inside a zone the team already has on Orbits DNS is on Orbits DNS too, whatever `dns` says: its record is created for it. Zones never nest: a zone around one already on Orbits DNS is refused (422 `dns`), and so is one inside or around another team's (409 `domain`). Orbits looks for it every minute (and at once with `POST .../checks`), issues the certificate once it's found, then serves the project on it. The person who added it gets an email when it's live, and another if DNS still isn't there an hour later.\n\nA domain the team already has that serves nothing (a zone moved to Orbits DNS before any project was picked) can be typed into a project's Add domain dialog like a new one: this call links it (200) instead of refusing it. `GET .../domains/preview` says beforehand what adding a name would do, for the dialog's note.\n\n**Permissions:** Owners, admins and members. Viewers get 403; a non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/domains#add-a-domain"
          },
          "response": []
        },
        {
          "name": "What adding a domain would do",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains/preview?domain=domain",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains",
                "preview"
              ],
              "query": [
                {
                  "key": "domain",
                  "value": "domain",
                  "description": "",
                  "disabled": false
                },
                {
                  "key": "dns",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "The Add domain dialogs' note, as the person types: whether the name would use outside DNS (one record to add, `required_record`), sit inside one of the team's Orbits DNS zones (`zone`, Orbits adds the record), or become a zone of its own (`nameservers`); and whether the team has it already (`existing`, which Add links to the project when it serves nothing). Nothing is saved. Checks the same rules as Add, with the same errors.\n\n**Permissions:** Owners, admins and members. Viewers get 403; a non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/domains#what-adding-a-domain-would-do"
          },
          "response": []
        },
        {
          "name": "A domain",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains/:domain",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains",
                ":domain"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "domain",
                  "value": "example.com",
                  "description": "The domain's name, or its `dom_` id."
                }
              ]
            },
            "description": "A domain's page: its state, the record it needs and what the last check found, the hostname card (which project and branch it serves, or where it redirects) and its certificate. While it's `pending`, refresh the page every few seconds or call `POST .../checks`.\n\n**Permissions:** Any team member. A non-member, or a domain of another team, gets 404.\n\nDocs: https://docs.orbits.africa/api/domains#a-domain"
          },
          "response": []
        },
        {
          "name": "Change what a domain serves",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains/:domain",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains",
                ":domain"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "domain",
                  "value": "example.com",
                  "description": "The domain's name, or its `dom_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"project\": null,\n  \"branch\": null,\n  \"to\": null\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "The hostname card's Change: point the domain at another project, a branch, production again, a redirect, or nothing (`project: null` leaves it \"Not in use\"). Send only what changes; `null` clears a field. The name and DNS mode don't change: remove the domain and add it again.\n\n**Permissions:** Owners, admins and members. Viewers get 403; a non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/domains#change-what-a-domain-serves"
          },
          "response": []
        },
        {
          "name": "Remove a domain",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains/:domain",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains",
                ":domain"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "domain",
                  "value": "example.com",
                  "description": "The domain's name, or its `dom_` id."
                }
              ]
            },
            "description": "Remove domain, after the dialog's confirmation. The project stops answering on it within a minute and its certificate is deleted. The record at the team's DNS provider stays until they delete it there.\n\n**Permissions:** Owners, admins and members. Viewers get 403; a non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/domains#remove-a-domain"
          },
          "response": []
        },
        {
          "name": "Look for the domain's DNS now",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains/:domain/checks",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains",
                ":domain",
                "checks"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "domain",
                  "value": "example.com",
                  "description": "The domain's name, or its `dom_` id."
                }
              ]
            },
            "description": "Check now. Orbits looks up the domain's DNS at once and answers with the domain as it stands, `checked_at` included. A domain checked in the last 10 seconds isn't looked up again; the answer is the same. Orbits also checks by itself every minute while a domain waits, and every 10 minutes once it's valid. A certificate follows within about a minute of DNS being found.\n\n**Permissions:** Any team member: checking changes nothing the team chose. A non-member gets 404.\n\nThis call ignores `Idempotency-Key`.\n\nDocs: https://docs.orbits.africa/api/domains#look-for-the-domains-dns-now"
          },
          "response": []
        }
      ]
    },
    {
      "name": "DNS",
      "description": "These routes manage the records of a domain whose nameservers are Orbits' (`ns1.theorbits.app` and `ns2.theorbits.app`). See [Orbits DNS](/domains/orbits-dns) and [Email records](/domains/email-records).",
      "item": [
        {
          "name": "A zone's records",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains/:domain/records",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains",
                ":domain",
                "records"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "domain",
                  "value": "example.com",
                  "description": "The domain's name, or its `dom_` id."
                }
              ]
            },
            "description": "The DNS records table on an Orbits DNS domain's page: every record the zone serves, the team's own and the ones Orbits manages for its projects (`used_by.kind: project`, `managed: true`, locked: they change from that project's Domains page). Email records (`used_by.kind: email`) came with Email setup and stay editable. The zone also has its SOA and NS records, which aren't listed.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/dns#a-zones-records"
          },
          "response": []
        },
        {
          "name": "Add a record",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains/:domain/records",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains",
                ":domain",
                "records"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "domain",
                  "value": "example.com",
                  "description": "The domain's name, or its `dom_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"type\": \"A\",\n  \"name\": \"@\",\n  \"value\": \"10 mx.zoho.com\",\n  \"ttl\": 0\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Add a DNS record. It's served within about a minute. A name Orbits manages for a project (the apex and `www` of a zone in use, a subdomain added as a domain) can't take another record there: add the domain from the project's Domains page instead. A CNAME can't share its name with any other record, and can't sit at `@`.\n\n**Permissions:** Owners, admins and members. Viewers get 403; a non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/dns#add-a-record"
          },
          "response": []
        },
        {
          "name": "Edit a record",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains/:domain/records/:record",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains",
                ":domain",
                "records",
                ":record"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "domain",
                  "value": "example.com",
                  "description": "The domain's name, or its `dom_` id."
                },
                {
                  "key": "record",
                  "value": "rec_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"type\": \"A\",\n  \"name\": \"@\",\n  \"value\": \"10 mx.zoho.com\",\n  \"ttl\": 0\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "The record menu's Edit: the record is replaced by what's sent, under the same rules as adding one. Records Orbits manages for a project can't be edited (409).\n\n**Permissions:** Owners, admins and members. Viewers get 403; a non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/dns#edit-a-record"
          },
          "response": []
        },
        {
          "name": "Delete a record",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains/:domain/records/:record",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains",
                ":domain",
                "records",
                ":record"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "domain",
                  "value": "example.com",
                  "description": "The domain's name, or its `dom_` id."
                },
                {
                  "key": "record",
                  "value": "rec_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "description": "The record menu's Delete, after its confirmation. Records Orbits manages for a project can't be deleted (409): remove the domain from the project instead.\n\n**Permissions:** Owners, admins and members. Viewers get 403; a non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/dns#delete-a-record"
          },
          "response": []
        },
        {
          "name": "Import a BIND zone file",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains/:domain/zone-imports",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains",
                ":domain",
                "zone-imports"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "domain",
                  "value": "example.com",
                  "description": "The domain's name, or its `dom_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"zone\": \"zone\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Import zone file. Send the pasted or dropped file with `dry_run: true` to show \"4 records found: 1 new, 3 already here\", then again without it to add the new ones. Records already in the zone (same type, name and value) are left as they are. Lines Orbits can't use (SOA, NS, records for another domain, types it doesn't host, names Orbits manages for a project) are counted in `skipped`, not guessed at.\n\n**Permissions:** Owners, admins and members. Viewers get 403; a non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/dns#import-a-bind-zone-file"
          },
          "response": []
        },
        {
          "name": "The Email setup dialog",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains/:domain/email",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains",
                ":domain",
                "email"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "domain",
                  "value": "example.com",
                  "description": "The domain's name, or its `dom_` id."
                }
              ]
            },
            "description": "Set up email for a zone: the provider set up now (the Active badge), how many of the zone's records came with it or are mail records (\"Already set up · 5 records\"), and for each provider the records Setup would add, less any that would clash with the team's own or Orbits' (for \"Adds 5 MX records and SPF\"). `other` is \"Something else\" and adds nothing. A name inside a zone answers with its zone's.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/dns#the-email-setup-dialog"
          },
          "response": []
        },
        {
          "name": "Set up email for a zone",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/domains/:domain/email",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "domains",
                ":domain",
                "email"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "domain",
                  "value": "example.com",
                  "description": "The domain's name, or its `dom_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"provider\": \"zoho\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Email setup: the zone's MX and SPF records for one provider, in place of the last provider's (records added by Email setup, `used_by.kind: email`). DMARC and the team's other TXT records stay. DKIM keys belong to the team's mail account, so they're added as records afterwards. `other` (\"Something else\") clears the provider and keeps every record, for the team to manage.\n\n**Permissions:** Owners, admins and members. Viewers get 403; a non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/dns#set-up-email-for-a-zone"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Runtime logs and observability",
      "description": "Runtime logs are what a project's deployments write while they run, and its requests, kept for 7 days. Build logs are a deployment's: see [Deployments](/api/deployments). See [Runtime logs](/observe/runtime-logs) and [Observability](/observe/observability).",
      "item": [
        {
          "name": "Runtime logs",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/logs",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "logs"
              ],
              "query": [
                {
                  "key": "q",
                  "value": "",
                  "description": "Matches a path or message (any case), or exactly a request ID, status or method. A request ID on its own (32 hex characters, as the edge makes them) matches only that request.",
                  "disabled": true
                },
                {
                  "key": "source",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "level",
                  "value": "",
                  "description": "A request is `error` for 5xx and `warning` for 4xx. An output line is `warning` when it mentions a warning, and `error` when it was written to stderr or mentions an error.",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "",
                  "description": "Requests only; output lines never match.",
                  "disabled": true
                },
                {
                  "key": "range",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "`next_cursor` from the previous page.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "The Logs page: every request the edge sent to one of the project's deployments (`source: requests`), and every line its deployments printed while running (`source: functions`), newest first. Build logs are on each deployment (`GET .../deployments/{deployment}/logs`). Entries are kept for 7 days.\n\nA request has `status`, `method`, `path` and `duration_ms`, and no `message`. An output line has `message` and `stream`, and null `status`, `method`, `path` and `duration_ms`. Requests and output lines are not linked: an app's output is whatever it printed, whichever request it was serving. Client IP addresses are stored masked (`102.89.x.x`), and query strings are not stored.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/logs#runtime-logs"
          },
          "response": []
        },
        {
          "name": "One runtime log entry",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/logs/:log",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "logs",
                ":log"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "log",
                  "value": "log_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": "A `log_` id from `GET .../logs`."
                }
              ]
            },
            "description": "One entry for the Logs inspector, when the one in the URL is not on the current page. 404 once it is older than 7 days.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/logs#one-runtime-log-entry"
          },
          "response": []
        },
        {
          "name": "Production's requests, errors and latency",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/observability",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "observability"
              ],
              "query": [
                {
                  "key": "range",
                  "value": "",
                  "description": "Buckets: 12 x 5 minutes, 12 x 30 minutes (the project overview's health), 24 x an hour, 7 x a day.",
                  "disabled": true
                },
                {
                  "key": "route",
                  "value": "",
                  "description": "A route from `all_routes`.",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "",
                  "description": "Narrows everything but `statuses`.",
                  "disabled": true
                },
                {
                  "key": "region",
                  "value": "",
                  "description": "A region code; `abj-1` is the only one with traffic.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "The Observability page: production's traffic over a range, from the runtime logs (the edge's requests to the project's production builds, at its address or a build's own). Requests and server errors (5xx) per bucket with p75 and p99 response times, totals with p50, p75 and p99 against the period before, the busiest routes, requests by status class and by region, and the routes for the Route filter. Times are milliseconds from the edge receiving a request to its last byte. Routes group a path's ids (`/products/8412` is `/products/[id]`) and a static folder's files (`/_next/*`). Percentiles are exact. Buckets are 12 x 5 minutes (`1h`), 24 x an hour (`24h`) or 7 x a day (`7d`), on Lagos's clock; the last is the one still filling.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/logs#productions-requests-errors-and-latency"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Analytics and Speed Insights",
      "description": "Analytics and Speed Insights come from the beacons sent by `@useorbits/analytics` and `@useorbits/speed-insights` in your app. Both are part of the Pro plan: on Free, reads answer `enabled: false` with `locked: true`, and turning one on is `402`. See [Analytics](/observe/analytics) and [Speed Insights](/observe/speed-insights).",
      "item": [
        {
          "name": "A project's visitors and page views",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/analytics",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "analytics"
              ],
              "query": [
                {
                  "key": "range",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "The Analytics page: page views the project's visitors' browsers sent with `@useorbits/analytics` (the edge's `/_orbits/analytics.js`, which sends beacons to `/_orbits/e` on the project's own host), to its production deployments only (not a preview's), over a range against the span before it. `buckets` are the range's hours (`24h`) or Lagos days (`7d`, `30d`), the last one still filling; `previous_buckets` are the span before, in the same order. A visitor is counted once a Lagos day: nothing identifies them across days, and neither their address nor their browser is kept. A bounce is a visitor with one page view. `pages` are by the route the framework named (`/blog/[slug]`, from the Next.js, SvelteKit and Astro components), or else the path with its ids grouped (`/products/8412` is `/products/[id]`). `referrers` are other sites' hosts; `host: null` is a visit nobody linked to. `countries` is empty until the edge looks them up. `events` are custom events (`track()`), most sent first. Lists keep their top ten.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/insights#a-projects-visitors-and-page-views"
          },
          "response": []
        },
        {
          "name": "Turn Analytics on or off",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/analytics",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "analytics"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"enabled\": false\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "The Analytics page's Enable switch. While it's off, production's hosts don't serve `/_orbits/analytics.js` and page views and events aren't logged; the edge picks a change up within seconds.\n\nTurning it **on** needs Pro: a team on Free gets 402 `plan_required` (feature `analytics`). Turning it off is always allowed.\n\n**Permissions:** Owners, admins and members. Viewers get 403; a non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/insights#turn-analytics-on-or-off"
          },
          "response": []
        },
        {
          "name": "One custom event and its properties",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/analytics/event?name=my-app",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "analytics",
                "event"
              ],
              "query": [
                {
                  "key": "name",
                  "value": "my-app",
                  "description": "",
                  "disabled": false
                },
                {
                  "key": "range",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "A custom event from the Analytics page's `events` (sent with `track(name, properties)`) over a range, production only: how often it was sent, by how many visitors, and its properties, ten at most, each with its ten commonest values. A value that isn't a string is shown as its JSON (`3`, `true`, `null`).\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/insights#one-custom-event-and-its-properties"
          },
          "response": []
        },
        {
          "name": "A project's Web Vitals from real visits",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/speed-insights",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "speed-insights"
              ],
              "query": [
                {
                  "key": "range",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "device",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "The Speed Insights page: Web Vitals the project's visitors' browsers measured and sent with `@useorbits/speed-insights` (the edge's `/_orbits/speed-insights.js`) from its production deployments, on one kind of device (`mobile` counts tablets), at the 75th percentile. LCP, INP, FCP and TTFB are milliseconds, CLS a unitless score. `score` is 0 to 100 from the p75s there are, as Lighthouse scores each metric (90 at its good line, 50 at its median) weighted FCP 15%, LCP 30%, INP 30% and CLS 25%; TTFB is shown but not scored; null without any. `lcp` is LCP's p75 by bucket (null where none was measured). `routes` are the most visited, ten at most, by the route the framework named or the path with its ids grouped, with each vital's p75 or null. `targets` are the elements (CSS selectors) most often behind LCP, INP and CLS, five each, with how often and their p75. `connections` are LCP samples by the connection they were measured on.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/insights#a-projects-web-vitals-from-real-visits"
          },
          "response": []
        },
        {
          "name": "Turn Speed Insights on or off",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/speed-insights",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "speed-insights"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"enabled\": false\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "The Speed Insights page's Enable switch. While it's off, production's hosts don't serve `/_orbits/speed-insights.js` and vitals aren't logged; the edge picks a change up within seconds.\n\nTurning it **on** needs Pro: a team on Free gets 402 `plan_required` (feature `speed_insights`). Turning it off is always allowed.\n\n**Permissions:** Owners, admins and members. Viewers get 403; a non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/insights#turn-speed-insights-on-or-off"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Feature flags",
      "description": "A flag has a value per environment and, in each, rules that pick a value for some visitors. Your app reads flags with `@useorbits/flags`, using the environment's key that deployments get as `ORBITS_FLAGS`. See [Feature flags](/features/flags).",
      "item": [
        {
          "name": "A project's feature flags",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/flags",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "flags"
              ],
              "query": [
                {
                  "key": "q",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "type",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "The Flags page: every flag, newest first, with each environment's setting. `q` matches the key or description, `type` narrows to one type; `total` counts them all, for \"3 of 5 flags\".\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/flags#a-projects-feature-flags"
          },
          "response": []
        },
        {
          "name": "Create a flag",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/flags",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "flags"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"key\": \"new-checkout\",\n  \"type\": \"boolean\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "A boolean flag starts off in each environment unless `environments.<name>.on` says otherwise, at 100% rollout and with no rules. A string or number flag needs `environments.<name>.value` for all three. Keys are lowercase letters, digits and single dashes, unique in the project.\n\n**Permissions:** Owners, admins and members. Viewers get 403.\n\nDocs: https://docs.orbits.africa/api/flags#create-a-flag"
          },
          "response": []
        },
        {
          "name": "Each environment's ORBITS_FLAGS key",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/flag-keys",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "flag-keys"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "Deployments get their environment's key as `ORBITS_FLAGS` (and the API's address as `ORBITS_API_URL`) without asking. These are for code that runs elsewhere: put `development`'s in `.env.local` to read Development's flags locally. A key reads its environment's flags and reports checks, nothing else.\n\n**Permissions:** Owners, admins and members. Viewers get 403.\n\nDocs: https://docs.orbits.africa/api/flags#each-environments-orbits_flags-key"
          },
          "response": []
        },
        {
          "name": "A flag, its history and who it was checked for",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/flags/:flag",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "flags",
                ":flag"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "flag",
                  "value": "new-checkout",
                  "description": ""
                }
              ]
            },
            "description": "The flag's page. `history` is newest first, 50 at most, each line written as the page says it. `seen` is each environment's last 24 hours as the SDK reported them: `people` the ids it was checked for, `checks` every check, with or without one.\n\n**Permissions:** Any team member.\n\nDocs: https://docs.orbits.africa/api/flags#a-flag-its-history-and-who-it-was-checked-for"
          },
          "response": []
        },
        {
          "name": "Change a flag's description",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/flags/:flag",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "flags",
                ":flag"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "flag",
                  "value": "new-checkout",
                  "description": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"description\": \"description\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "The key and type never change; make another flag for that.\n\n**Permissions:** Owners, admins and members.\n\nDocs: https://docs.orbits.africa/api/flags#change-a-flags-description"
          },
          "response": []
        },
        {
          "name": "Delete a flag",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/flags/:flag",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "flags",
                ":flag"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "flag",
                  "value": "new-checkout",
                  "description": ""
                }
              ]
            },
            "description": "The SDK stops getting it on its next refresh, and code checking it gets the default it passed.\n\n**Permissions:** Owners, admins and members.\n\nDocs: https://docs.orbits.africa/api/flags#delete-a-flag"
          },
          "response": []
        },
        {
          "name": "Switch a flag, set its rollout or its value in one environment",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/flags/:flag/environments/:environment",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "flags",
                ":flag",
                "environments",
                ":environment"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "flag",
                  "value": "new-checkout",
                  "description": ""
                },
                {
                  "key": "environment",
                  "value": "production",
                  "description": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"on\": false,\n  \"rollout\": 1,\n  \"value\": \"value\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "A boolean flag takes `on` and `rollout` (1–100, the share of ids it's on for); a string or number flag takes `value`. Fields left out stay as they are. Deployments see the change within seconds, without a redeploy.\n\n**Permissions:** Owners, admins and members.\n\nDocs: https://docs.orbits.africa/api/flags#switch-a-flag-set-its-rollout-or-its-value-in-one-environment"
          },
          "response": []
        },
        {
          "name": "Add a targeting rule",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/flags/:flag/environments/:environment/rules",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "flags",
                ":flag",
                "environments",
                ":environment",
                "rules"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "flag",
                  "value": "new-checkout",
                  "description": ""
                },
                {
                  "key": "environment",
                  "value": "production",
                  "description": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"attribute\": \"email\",\n  \"operator\": \"equals\",\n  \"values\": [\n    \"@kudi.ng\"\n  ],\n  \"serve\": false\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Rules are checked in order before the environment's switch: the first that matches decides, `serve` being on or off for a boolean flag and the value for the others. `attribute` names what the app passes to `flag()` (`email`, `id`, `plan`, `user.country`); `one_of` takes several values, every other operator one; comparisons ignore case, and an attribute the app didn't pass matches nothing. 20 rules at most.\n\n**Permissions:** Owners, admins and members.\n\nDocs: https://docs.orbits.africa/api/flags#add-a-targeting-rule"
          },
          "response": []
        },
        {
          "name": "Change what a rule serves",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/flags/:flag/environments/:environment/rules/:rule",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "flags",
                ":flag",
                "environments",
                ":environment",
                "rules",
                ":rule"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "flag",
                  "value": "new-checkout",
                  "description": ""
                },
                {
                  "key": "environment",
                  "value": "production",
                  "description": ""
                },
                {
                  "key": "rule",
                  "value": "rule_1",
                  "description": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"serve\": false\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "**Permissions:** Owners, admins and members.\n\nDocs: https://docs.orbits.africa/api/flags#change-what-a-rule-serves"
          },
          "response": []
        },
        {
          "name": "Remove a rule",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/flags/:flag/environments/:environment/rules/:rule",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "flags",
                ":flag",
                "environments",
                ":environment",
                "rules",
                ":rule"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "flag",
                  "value": "new-checkout",
                  "description": ""
                },
                {
                  "key": "environment",
                  "value": "production",
                  "description": ""
                },
                {
                  "key": "rule",
                  "value": "rule_1",
                  "description": ""
                }
              ]
            },
            "description": "**Permissions:** Owners, admins and members.\n\nDocs: https://docs.orbits.africa/api/flags#remove-a-rule"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Workflows",
      "description": "Workflows are defined in your app's code with `@useorbits/workflows`; these routes list them and their runs, start a run, and cancel or retry one. See [Workflows](/features/workflows).",
      "item": [
        {
          "name": "A project's workflows and recent runs",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/workflows",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "workflows"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "The Workflows page. `workflows` are what the production deployment's `@useorbits/workflows` lists, read once it went live: each with its trigger as the page says it (\"Every 15 minutes\", \"When order.paid happens\"), its last run, and the share of its finished runs in the last 7 days that succeeded (null without any). `runs` are the 50 newest, each with its steps.\n\nA run's steps are the `step()`, `sleep()` and `waitFor()` calls it reached, in order. A step `running` with an `error` failed an attempt and is waiting for its retry (`next_at`). Steps the workflow took on its last successful run that this run hasn't reached are listed after them: `waiting` while it runs, `skipped` once it failed or was canceled.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/workflows#a-projects-workflows-and-recent-runs"
          },
          "response": []
        },
        {
          "name": "Run a workflow now",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/workflows/:workflow/runs",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "workflows",
                ":workflow",
                "runs"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "workflow",
                  "value": "send-welcome-email",
                  "description": ""
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"input\": null\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Starts a run on the production deployment with `input` (any JSON, 256 KB at most), as Run now does. The builder picks it up within seconds.\n\n**Permissions:** Owners, admins and members. Viewers get 403. 404 when the production deployment doesn't list the workflow; 409 without a production deployment.\n\nDocs: https://docs.orbits.africa/api/workflows#run-a-workflow-now"
          },
          "response": []
        },
        {
          "name": "One run and its steps",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/workflows/runs/:run",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "workflows",
                "runs",
                ":run"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "run",
                  "value": "run_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "description": "**Permissions:** Any team member.\n\nDocs: https://docs.orbits.africa/api/workflows#one-run-and-its-steps"
          },
          "response": []
        },
        {
          "name": "Cancel a running run",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/workflows/runs/:run/cancel",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "workflows",
                "runs",
                ":run",
                "cancel"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "run",
                  "value": "run_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "description": "The app isn't called for it again; a step already running finishes, and its result is dropped. 409 for a run that isn't running.\n\n**Permissions:** Owners, admins and members.\n\nDocs: https://docs.orbits.africa/api/workflows#cancel-a-running-run"
          },
          "response": []
        },
        {
          "name": "Retry a failed run from the step that failed",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/workflows/runs/:run/retry",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "workflows",
                "runs",
                ":run",
                "retry"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "run",
                  "value": "run_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "description": "The steps before the failed one keep their results; the failed one runs again with a fresh set of attempts, and the run goes on from there. 409 for a run that didn't fail.\n\n**Permissions:** Owners, admins and members.\n\nDocs: https://docs.orbits.africa/api/workflows#retry-a-failed-run-from-the-step-that-failed"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Sandboxes",
      "description": "Sandboxes need the Pro plan: on Free, creating or starting one answers 402. The guide is [Sandboxes](/features/sandboxes). The terminal itself is a WebSocket, opened with a 60-second ticket from the terminal-ticket call, so it is not listed here as a JSON endpoint.",
      "item": [
        {
          "name": "A project's sandboxes",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/sandboxes",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "sandboxes"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "The Sandboxes page: every sandbox, the live ones first and then by most recently started. `running` counts the live ones (starting or running) and `limit` is the most a team may run at once, for \"2 of 3 running\" and to disable Create at the cap. `as_of` is the server's clock, for the page's relative times. The page polls this while any sandbox is `starting`.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/sandboxes#a-projects-sandboxes"
          },
          "response": []
        },
        {
          "name": "Start a sandbox",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/sandboxes",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "sandboxes"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"seed-test-data\",\n  \"runtime\": \"node22\",\n  \"size\": \"small\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Provisions a machine and boots it: `state` is `starting`, then `running` once it is up (poll `GET .../sandboxes`). `clone` checks out the project's repository at `main`; `env` copies the Preview environment variables in. `size` caps CPU, memory and disk; `stop_after` is the idle minutes before it suspends itself. Names are lowercase letters, digits and single dashes, unique among the project's live sandboxes.\n\nA team runs at most `SandboxPage.limit` sandboxes at once; past that this returns 409 and the page offers to stop one first.\n\n**Runtime (v1):** a sandbox is a Docker container on the build host, capped by cgroups, with the terminal backed by `docker exec`. Stronger isolation (Firecracker microVMs) is a later swap that does not change this contract.\n\n**Permissions:** Owners, admins and members. Viewers get 403.\n\nDocs: https://docs.orbits.africa/api/sandboxes#start-a-sandbox"
          },
          "response": []
        },
        {
          "name": "A sandbox, its usage and open ports",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/sandboxes/:sandbox",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "sandboxes",
                ":sandbox"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "sandbox",
                  "value": "sbx_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": "The sandbox's name."
                }
              ]
            },
            "description": "The sandbox's page: its `usage` against the size's ceiling, the `terminal` output so far, and the `ports` it listens on (port 3000, team-only, in v1). Use `{sandbox}` from `GET .../sandboxes`.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/sandboxes#a-sandbox-its-usage-and-open-ports"
          },
          "response": []
        },
        {
          "name": "Delete a sandbox",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/sandboxes/:sandbox",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "sandboxes",
                ":sandbox"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "sandbox",
                  "value": "sbx_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": "The sandbox's name."
                }
              ]
            },
            "description": "Terminates the machine and frees its disk. Irreversible; unlike stop, nothing is kept.\n\n**Permissions:** Owners, admins and members. Viewers get 403.\n\nDocs: https://docs.orbits.africa/api/sandboxes#delete-a-sandbox"
          },
          "response": []
        },
        {
          "name": "Suspend a sandbox",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/sandboxes/:sandbox/stop",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "sandboxes",
                ":sandbox",
                "stop"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "sandbox",
                  "value": "sbx_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": "The sandbox's name."
                }
              ]
            },
            "description": "Suspends the sandbox: CPU and memory are released, the disk is kept, and `start` resumes it with the work intact. The idle auto-stop does the same, so a timeout never loses work. `state` becomes `stopped`. Already stopped is a no-op 200.\n\n**Permissions:** Owners, admins and members. Viewers get 403.\n\nDocs: https://docs.orbits.africa/api/sandboxes#suspend-a-sandbox"
          },
          "response": []
        },
        {
          "name": "Resume a sandbox",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/sandboxes/:sandbox/start",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "sandboxes",
                ":sandbox",
                "start"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "sandbox",
                  "value": "sbx_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": "The sandbox's name."
                }
              ]
            },
            "description": "Resumes a stopped sandbox from its kept disk: `state` is `starting`, then `running` (poll `GET .../sandboxes`). Counts against the team's live limit, so this returns 409 when the team is already at `SandboxPage.limit`. Already running is a no-op 200.\n\n**Permissions:** Owners, admins and members. Viewers get 403.\n\nDocs: https://docs.orbits.africa/api/sandboxes#resume-a-sandbox"
          },
          "response": []
        },
        {
          "name": "A ticket to open the sandbox's terminal",
          "request": {
            "method": "POST",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/sandboxes/:sandbox/terminal-ticket",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "sandboxes",
                ":sandbox",
                "terminal-ticket"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "sandbox",
                  "value": "sbx_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": "The sandbox's name."
                }
              ]
            },
            "description": "A WebSocket opened by a browser can't carry the session or a bearer, so the terminal (`GET .../sandboxes/{sandbox}/terminal`) takes this ticket in its `ticket` query parameter instead. The ticket (`sbt_…`) admits the caller to this one sandbox's terminal for 60 seconds: get one right before opening the socket. It is signed, not stored, so it can't be revoked before it expires. Takes no body. The answer is never cached and the call ignores `Idempotency-Key`, so every call mints a new ticket.\n\nNo plan check of its own: the sandbox must be `running` (else 409), and only Pro can start one.\n\n**Permissions:** Any team member, viewers included. A session or a `full` API token may call it (a token limited to one project only for that project); a `read` token gets 403, because this is a POST. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/sandboxes#a-ticket-to-open-the-sandboxs-terminal"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Alerts",
      "description": "An alert watches one of a project's metrics over a window and notifies the team's channels when it crosses its threshold, and again when it recovers. Preview a rule against recent data before saving it. See [Alerts](/observe/alerts).",
      "item": [
        {
          "name": "A project's alert rules and their state",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/alerts",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "alerts"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "description": "The Alerts card on Observability: every rule of the project, oldest first, with its state. A rule watches production's requests (the same traffic as Observability) and is checked every minute, at :30, over its last `window_minutes` whole minutes. It fires as soon as its value is past the line (above `threshold`, or below it for `direction: below`), and resolves after 3 checks in a row back on the right side. `error-rate`, `p75` and `p99` need 20 requests in the window to say anything: under that a rule can't fire, and `last_value` is null. A firing rule counts such a check toward resolving, unless what few requests there were are still past the line, and resolves with `reason: quiet` when the last of the 3 is one. `webhook_configured` says whether `webhook` can be offered as a channel.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/alerts#a-projects-alert-rules-and-their-state"
          },
          "response": []
        },
        {
          "name": "Create an alert rule",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/alerts",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "alerts"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"my-app\",\n  \"metric\": \"error-rate\",\n  \"threshold\": 1,\n  \"window_minutes\": 1,\n  \"channels\": [\n    \"webhook\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "The Create alert form. The rule starts `ok` and is first checked at the next :30. 422 names the field: a name already used in the project, `direction: below` for anything but `requests`, an `error-rate` threshold of 100 or more, a route that doesn't start with `/` or has a `*` anywhere but the end, or `webhook` in `channels` while the team has no webhook (`webhook_configured` on the list).\n\n**Permissions:** Owner, admin or member of the team. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/alerts#create-an-alert-rule"
          },
          "response": []
        },
        {
          "name": "How much traffic a draft rule would see",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/alerts/preview",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "alerts",
                "preview"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"metric\": \"error-rate\",\n  \"window_minutes\": 1\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "For the Create and Edit forms. `median_requests` is the median number of requests a window of this size held over the last 24 hours on these routes (minutes without traffic count as none). When it is under `minimum_requests` (20 for `error-rate`, `p75` and `p99`; 0 for `requests`), warn under the window field, for example \"These routes get about 6 requests in 1 minute. The rule won't fire until a window has 20. Try 5 or 10 minutes.\" It is a warning: the form can still be saved. `value` is what the rule would measure now, or null with too little traffic.\n\n**Permissions:** Owner, admin or member of the team. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/alerts#how-much-traffic-a-draft-rule-would-see"
          },
          "response": []
        },
        {
          "name": "Change or switch an alert rule",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/alerts/:alert",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "alerts",
                ":alert"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "alert",
                  "value": "alr_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": "An `alr_` id from `GET .../alerts`."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"my-app\",\n  \"metric\": \"error-rate\",\n  \"direction\": \"above\",\n  \"threshold\": 1,\n  \"window_minutes\": 1,\n  \"routes\": [\n    \"routes\"\n  ],\n  \"channels\": [\n    \"webhook\"\n  ],\n  \"on\": false\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "The rule's switch, and the Edit dialog. Send only what changes. Any change, switching it off or on included, starts the rule again from `ok`. A rule that was firing first resolves, so a receiver sees its incident close: `reason: changed` for an edit, `off` when switched off. Changing `metric` away from `requests` sets `direction` to `above` unless one is sent. 422 as for create.\n\n**Permissions:** Owner, admin or member of the team. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/alerts#change-or-switch-an-alert-rule"
          },
          "response": []
        },
        {
          "name": "Delete an alert rule",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/alerts/:alert",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "alerts",
                ":alert"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "alert",
                  "value": "alr_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": "An `alr_` id from `GET .../alerts`."
                }
              ]
            },
            "description": "Deletes the rule and its history. A rule that was firing sends `alert.resolved` with `reason: deleted` first.\n\n**Permissions:** Owner, admin or member of the team. Viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/alerts#delete-an-alert-rule"
          },
          "response": []
        },
        {
          "name": "When a rule fired and resolved",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/projects/:project/alerts/:alert/events",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "projects",
                ":project",
                "alerts",
                ":alert",
                "events"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "project",
                  "value": "my-app",
                  "description": "Project slug or `prj_` id."
                },
                {
                  "key": "alert",
                  "value": "alr_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "description": "A rule's history, newest first, kept 90 days, with how each notification went (`deliveries`: one per channel, `pending` while it is still being tried, up to 5 times over about 30 minutes).\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/alerts#when-a-rule-fired-and-resolved"
          },
          "response": []
        },
        {
          "name": "The team's alert webhook",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/alert-channels",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "alert-channels"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "The webhook every rule with the `webhook` channel sends to, one per team, or null. The secret is never shown again after it is made; `secret_last4` identifies it.\n\n**Permissions:** Owner or admin of the team. Members and viewers get 403 (the list's `webhook_configured` tells them whether one is set). A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/alerts#the-teams-alert-webhook"
          },
          "response": []
        },
        {
          "name": "Set the team's alert webhook",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/alert-channels/webhook",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "alert-channels",
                "webhook"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"https://my-app.theorbits.app\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Sets the URL (https only). The first time, or with `rotate_secret`, a new secret is made and returned in `secret`, this once; the old one stops working at once. Otherwise `secret` is null and the secret is kept.\n\nEvery request Orbits sends is a JSON `POST` with `X-Signature-256: sha256=<hex>` (HMAC-SHA256 of the raw body with the secret), `X-Delivery-Id` (the same on every retry of one notification) and `X-Orbits-Event` (`alert.fired`, `alert.resolved` or `alert.test`). The body is an AlertWebhookPayload. A 2xx answer is delivered; anything else, or no answer in 10 seconds, is tried again. Redirects aren't followed, and addresses that aren't on the public internet are refused. The webhook-receiver template verifies these as they are.\n\n**Permissions:** Owner or admin of the team. Members and viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/alerts#set-the-teams-alert-webhook"
          },
          "response": []
        },
        {
          "name": "Remove the team's alert webhook",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/alert-channels/webhook",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "alert-channels",
                "webhook"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "Notifications still waiting for the webhook fail with \"The team has no webhook\".\n\n**Permissions:** Owner or admin of the team. Members and viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/alerts#remove-the-teams-alert-webhook"
          },
          "response": []
        },
        {
          "name": "Send a test event to the webhook",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Idempotency-Key",
                "value": "{{$guid}}",
                "description": "A new value per change. To retry safely, resend with the same value."
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/alert-channels/webhook/test",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "alert-channels",
                "webhook",
                "test"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "Sends a signed `alert.test` now and says how it went: `delivered` for a 2xx answer, otherwise the receiver's `status` (null when nothing answered) and an `error` to show. 404 when the team has no webhook.\n\n**Permissions:** Owner or admin of the team. Members and viewers get 403. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/alerts#send-a-test-event-to-the-webhook"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Integrations",
      "description": "An API token can list the team's integrations. Connecting, changing and disconnecting them (Git providers, Slack, Microsoft Teams, webhooks) holds the team's credentials with other services, so it is done in the dashboard. See [Integrations](/team/integrations) and [Git](/deploy/git).",
      "item": [
        {
          "name": "Catalog with installed state",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/integrations",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "integrations"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "The Integrations page: the Browse tab cards (name, description, Installed or Install) and the Installed tab rows (name, a one-line summary, scope, when it was installed, by whom).\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/integrations#catalog-with-installed-state"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Billing",
      "description": "Read which plan a team is on, what it includes, and its invoices. Paying, cancelling and resuming happen in the dashboard, by an owner: an API token may read billing but never change it. See [Plans](/billing/plans).",
      "item": [
        {
          "name": "The plans and their prices",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/plans",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "plans"
              ]
            },
            "description": "Orbits has two plans. **Free** is unlimited projects, with apps that scale to zero, and without server functions, sandboxes and Analytics or Speed Insights. **Pro** is `usd_cents: 500` a month and has all of them. `ngn` is the Naira amount charged for the price: the USD price at `rate` (a rate Orbits sets, `USD → NGN`), rounded up to a whole ₦100. It is `null` until the server has a rate set (then Pro can't be bought yet). The amount a payment is actually taken for is locked on the invoice when checkout starts, so show `ngn` as \"about\" only if you need to hedge; `POST .../billing/checkout` refuses with 409 if the amount you showed no longer matches.\n\n`features` describe the plan, not the team, and are the same whether or not limits are being enforced yet (`enforced` on `GET /v1/teams/{team}/billing` says whether they are).\n\nDocs: https://docs.orbits.africa/api/billing#the-plans-and-their-prices"
          },
          "response": []
        },
        {
          "name": "The team's plan and billing state",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/billing",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "billing"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "What the Settings Plan card and the Billing page show: the plan, whether it is `active`, `past_due` (a payment failed and the team is in its grace period) or `free`, the current period, what the next charge will be, what the plan allows, and (for owners) the card on file. `enforced` is false while Orbits has not switched plan limits on: every feature works for every team and `entitlements` all say true, although `plan` still says what the team is on.\n\n**Permissions:** Any team member sees the plan; the card is shown to owners only. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/billing#the-teams-plan-and-billing-state"
          },
          "response": []
        },
        {
          "name": "The team's invoices",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/billing/invoices",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "billing",
                "invoices"
              ],
              "query": [
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "The Invoices list: payments made for Pro, newest first. Payments that were started and never paid are not listed. `limit` is 1 to 100 (default 25); there is no cursor yet.\n\n**Permissions:** Team owners only; other members get 403.\n\nDocs: https://docs.orbits.africa/api/billing#the-teams-invoices"
          },
          "response": []
        },
        {
          "name": "One invoice, as a receipt",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/billing/invoices/:invoice",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "billing",
                "invoices",
                ":invoice"
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                },
                {
                  "key": "invoice",
                  "value": "inv_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": "An `id` from `GET .../billing/invoices`."
                }
              ]
            },
            "description": "The invoice with who paid, for which team, what for, and the card (brand and last four) it was paid with. There is no PDF; the dashboard renders the receipt.\n\n**Permissions:** Team owners only. An invoice of another team is 404.\n\nDocs: https://docs.orbits.africa/api/billing#one-invoice-as-a-receipt"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Usage, activity and operations",
      "description": "`GET .../usage` is what the team used in a period; `GET .../activity` is the feed of what happened, kept 90 days. A change that takes time answers `202` with an operation: poll `GET /v1/operations/{operation}` until its `state` is `succeeded` or `failed`.",
      "item": [
        {
          "name": "A month of the team's usage, by day and by project",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/usage",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "usage"
              ],
              "query": [
                {
                  "key": "month",
                  "value": "",
                  "description": "Defaults to this month. A month still to come is 422.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "The team's Usage page and its CSV, a project's Usage page (its `by_project` row), and the overview's usage panel. Days are Lagos days. `requests`, `bandwidth_bytes` (bytes the edge sent, headers included) and `log_lines` come from a daily rollup of the runtime logs kept 400 days; bandwidth is counted from when the edge started recording it, so earlier requests count 0 bytes. `build_minutes` (start to finish of each build, failed ones included) and `deployments` count deployments by the day they were created, back to the team's first. `function_runs` counts requests to projects with a `function` workload (also in `requests`): each is a call to the function, though functions run as one long-lived server until a per-call runtime ships. Figures for today are as of the call.\n\n`previous` is the same days of the month before, for \"+18% on September\", or null when the team had no deployments before this month. `months` lists every month from the team's first deployment to now, newest first.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/usage-and-activity#a-month-of-the-teams-usage-by-day-and-by-project"
          },
          "response": []
        },
        {
          "name": "Team activity feed",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/teams/:team/activity",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "teams",
                ":team",
                "activity"
              ],
              "query": [
                {
                  "key": "q",
                  "value": "",
                  "description": "Matches the sentence, the actor's name or the project's name, in any case.",
                  "disabled": true
                },
                {
                  "key": "actor",
                  "value": "",
                  "description": "A person's `id` from `people`.",
                  "disabled": true
                },
                {
                  "key": "project",
                  "value": "",
                  "description": "A project's `id` or `slug`.",
                  "disabled": true
                },
                {
                  "key": "type",
                  "value": "",
                  "description": "One `ActivityCategory`, or several separated by commas.",
                  "disabled": true
                },
                {
                  "key": "since",
                  "value": "",
                  "description": "Oldest line to return; defaults to 7 days ago, and is clamped to 90 days ago.",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "`next_cursor` from the previous page.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "team",
                  "value": "my-team",
                  "description": "Team slug or `team_` id."
                }
              ]
            },
            "description": "The team's Activity page and its export: what happened across the team, newest first, one sentence each. Deployments (a preview started, production deployed, promoted or rolled back, a build failed), environment variables (added, updated, removed, restored, revealed, pulled), projects (created, renamed, settings changed, paused, deleted, moved in), members (joined, left, role changed), team settings and integrations (GitHub connected or disconnected). Invites and domains aren't in it yet. Lines are written from the platform's events a moment after they happen, kept 90 days, and read as they did then: a project or member renamed since keeps its old name in older lines.\n\n**Permissions:** Any team member. A non-member gets 404.\n\nDocs: https://docs.orbits.africa/api/usage-and-activity#team-activity-feed"
          },
          "response": []
        },
        {
          "name": "Poll an asynchronous operation",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/operations/:operation",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "operations",
                ":operation"
              ],
              "variable": [
                {
                  "key": "operation",
                  "value": "op_01jc8x6e4mq2v7r9y3t5b0zp8w",
                  "description": ""
                }
              ]
            },
            "description": "Poll an asynchronous operation.\n\n**Permissions:** The starter of the operation or an owner or admin of the team it ran in.\n\nDocs: https://docs.orbits.africa/api/usage-and-activity#poll-an-asynchronous-operation"
          },
          "response": []
        }
      ]
    }
  ]
}
