For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scout DocsAccess Scout
API & SDK
API & SDK
  • Endpoints
      • GETList all environments for a workflow
      • PUTUpdate a workflow environment
LogoLogo
Scout DocsAccess Scout
EndpointsEnvironments

List all environments for a workflow

Beta
GET
https://api.scoutos.com/v2/workflows/:workflow_id/environments
GET
/v2/workflows/:workflow_id/environments
$curl https://api.scoutos.com/v2/workflows/workflow_id/environments \
>     -H "Authorization: Bearer <token>"
1{
2  "data": [
3    {
4      "environment_id": "env-7f3a2b9c",
5      "environment_config": {
6        "name": "Production",
7        "description": "Primary production environment serving live traffic"
8      },
9      "created_at": "2023-11-20T14:22:00Z",
10      "created_by": {
11        "type": "user",
12        "details": {
13          "user_id": "user-1234abcd",
14          "org_id": "org-5678efgh",
15          "scout_organization_id": "scout-org-9012ijkl",
16          "email": {
17            "address": "jane.doe@example.com",
18            "verified": true
19          }
20        }
21      },
22      "last_updated_at": "2024-04-10T08:45:00Z",
23      "last_updated_by": {
24        "type": "user",
25        "details": {
26          "user_id": "user-9876wxyz",
27          "org_id": "org-5678efgh",
28          "scout_organization_id": "scout-org-9012ijkl",
29          "email": {
30            "address": "john.smith@example.com",
31            "verified": true
32          }
33        }
34      },
35      "deployments": [
36        {
37          "deployment_id": "deploy-3a9f7c2e",
38          "environment_id": "env-7f3a2b9c",
39          "deployment_config": {
40            "revision_lookup": "revision_id",
41            "revision_id": "rev-20240410a",
42            "traffic": 100
43          },
44          "created_at": "2024-04-10T08:30:00Z",
45          "created_by": {
46            "type": "user",
47            "details": {
48              "user_id": "user-9876wxyz",
49              "org_id": "org-5678efgh",
50              "scout_organization_id": "scout-org-9012ijkl",
51              "email": {
52                "address": "john.smith@example.com",
53                "verified": true
54              }
55            }
56          }
57        }
58      ]
59    }
60  ]
61}
List all environments for a workflow in the organization
Was this page helpful?
Previous

Update a workflow environment

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

workflow_idstringRequired

Response

Successful Response
datalist of objects

Errors

422
Unprocessable Entity Error