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": "string",
5       "environment_config": {
6         "name": "string",
7         "description": "string"
8       },
9       "created_at": "2024-01-15T09:30:00Z",
10       "created_by": {
11         "type": "user",
12         "details": {
13           "api_key": {}
14         }
15       },
16       "last_updated_at": "2024-01-15T09:30:00Z",
17       "last_updated_by": {
18         "type": "user",
19         "details": {
20           "api_key": {}
21         }
22       },
23       "deployments": [
24         {
25           "deployment_id": "string",
26           "environment_id": "string",
27           "deployment_config": {
28             "revision_lookup": "latest",
29             "revision_id": "string",
30             "traffic": 100
31           },
32           "created_at": "2024-01-15T09:30:00Z",
33           "created_by": {
34             "type": "user",
35             "details": {
36               "api_key": {}
37             }
38           }
39         }
40       ]
41     }
42   ]
43 }

List all environments for a workflow in the organization

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

Authentication

Path parameters

Response

Errors