v1

latestOpenAPI 3.0.02026-07-249372139.7 KB
Environments

Environments

Fetch all environments in your Service Provider.

get/environments

Query parameters

fields[]string[]

Will only return the fields specified from this parameter, multiple uses of the parameter required for multiple fields

{"stackTrail":"paths:/environments:get:parameters:1:schema","oasType":"schema","type":"unknown"}

conditions[]={"path":"Field Path","op":"Operator","value":"value"}

Response

IDinteger
ServiceProviderIDinteger
Namestring
ShortNamestring
Descriptionstring
Statusinteger
Visibleboolean
ExpiresOnstring
KeyRotationinteger
Websitestring
Staticboolean
CreatedOnstring
UpdatedOnstring

Example response

[
  {
    "ID": 8888,
    "ServiceProviderID": 1,
    "Name": "Contoso Nation",
    "ShortName": "CN",
    "Description": "Example Description",
    "Status": 1,
    "Visible": true,
    "ExpiresOn": "2021-09-10T19:21:03.195Z",
    "KeyRotation": 90,
    "Website": "contoso.com",
    "CreatedOn": "2021-09-10T19:21:03.195Z",
    "UpdatedOn": "2021-09-10T19:21:03.195Z",
    "Tier": {
      "Type": "Core",
      "AssociatedInspectors": 14
    },
    "CreatedBy": {
      "ID": 1234,
      "FirstName": "Alex",
      "LastName": "Weber",
      "Username": "Alex.Weber"
    }
  }
]