List all environments for a workflow

Beta

GET

https://api-prod.scoutos.com/v2/workflows/:workflow_id/environments

GET

/v2/workflows/:workflow_id/environments

1 from scoutos import Scout
2 
3 client = Scout(
4     api_key="YOUR_API_KEY",
5 )
6 client.environments.list(
7     workflow_id="workflow_id",
8 )

Try it

1 {
2   "data": [
3     {
4       "environment_id": "environment_id",
5       "environment_config": {
6         "name": "name",
7         "description": "description"
8       },
9       "created_at": "created_at",
10       "created_by": {
11         "type": "user",
12         "details": {
13           "user_id": "user_id",
14           "org_id": "org_id",
15           "scout_organization_id": "scout_organization_id",
16           "email": {}
17         }
18       },
19       "last_updated_at": "last_updated_at",
20       "last_updated_by": {
21         "type": "user",
22         "details": {
23           "user_id": "user_id",
24           "org_id": "org_id",
25           "scout_organization_id": "scout_organization_id",
26           "email": {}
27         }
28       },
29       "deployments": [
30         {
31           "deployment_id": "deployment_id",
32           "environment_id": "environment_id",
33           "deployment_config": {
34             "revision_id": "revision_id",
35             "revision_lookup": "latest",
36             "traffic": 100
37           },
38           "created_at": "created_at",
39           "created_by": {
40             "type": "user",
41             "details": {
42               "user_id": "user_id",
43               "org_id": "org_id",
44               "scout_organization_id": "scout_organization_id",
45               "email": {}
46             }
47           }
48         }
49       ]
50     }
51   ]
52 }

List all environments for a workflow in the organization

Path parameters

workflow_idstringRequired

Response

Successful Response

datalist of objects

List all environments for a workflow

Path parameters

Headers

Response

Errors