Requires the environments-view
capability.
Returns a list of Environments.
General error response from the platform
{- "data": [
- {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "name": "string",
- "cluster": "string",
- "about": {
- "description": "string",
- "favorite": true
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "features": {
- "legacy_networking": true,
- "monitoring": {
- "tier": "limited"
}
}, - "services": {
- "loadbalancer": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "ipv4": true,
- "ipv6": true,
- "type": "v1",
- "details": {
- "controllers": [
- null
], - "controller_template": {
- "identifier": null,
- "port": null,
- "waf": null,
- "transport": { }
}, - "waf": {
- "rules": [ ]
}
}, - "bind_host": true
}
}, - "discovery": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "empty_set_delay": "72h45m2s",
- "hosts": {
- "property1": {
- "ipv4": [ ],
- "ipv6": [ ]
}, - "property2": {
- "ipv4": [ ],
- "ipv6": [ ]
}
}
}
}, - "vpn": {
- "enable": true,
- "container_id": "string",
- "auto_update": true,
- "config": {
- "allow_internet": true,
- "auth": {
- "webhook": "string",
- "cycle_accounts": true,
- "vpn_accounts": true
}
}
}, - "scheduler": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "public": true,
- "access_keys": [
- {
- "name": null,
- "secret": null,
- "ips": [ ]
}
]
}
}
}, - "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}, - "private_network": {
- "vxlan_tag": 0,
- "subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}
}
}, - "deployments": {
- "tags": {
- "property1": "v1.2.3-dev",
- "property2": "v1.2.3-dev"
}
}, - "meta": {
- "containers_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "instances_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "containers": [
- {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": null,
- "time": null
}
}, - "image": {
- "id": "651586fca6078e98982dbd90",
- "service": "discovery"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string",
- "container_subnet": "string",
- "ipv6": {
- "ip": null,
- "cidr": null
}, - "legacy": {
- "subnet": null,
- "ipv4": null
}
}
}
]
}
}
], - "includes": {
- "creators": {
- "accounts": {
- "property1": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}, - "property2": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}
}, - "employees": null,
- "visitors": null,
- "environments": null,
- "api_keys": null
}
}
}
Requires the environments-create
capability.
Returns an Environment.
General error response from the platform
{- "name": "string",
- "identifier": "string",
- "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}, - "cluster": "string",
- "about": {
- "description": "string"
}, - "features": {
- "legacy_networking": true,
- "monitoring": {
- "tier": "limited"
}
}
}
{- "data": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "name": "string",
- "cluster": "string",
- "about": {
- "description": "string",
- "favorite": true
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "features": {
- "legacy_networking": true,
- "monitoring": {
- "tier": "limited"
}
}, - "services": {
- "loadbalancer": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "ipv4": true,
- "ipv6": true,
- "type": "v1",
- "details": {
- "controllers": [
- {
- "identifier": null,
- "port": null,
- "waf": null,
- "transport": { }
}
], - "controller_template": {
- "identifier": "string",
- "port": 0,
- "waf": {
- "rules": [ ]
}, - "transport": {
- "disable": null,
- "mode": null,
- "config": { },
- "routers": [ ]
}
}, - "waf": {
- "rules": [
- { }
]
}
}, - "bind_host": true
}
}, - "discovery": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "empty_set_delay": "72h45m2s",
- "hosts": {
- "property1": {
- "ipv4": [
- null
], - "ipv6": [
- null
]
}, - "property2": {
- "ipv4": [
- null
], - "ipv6": [
- null
]
}
}
}
}, - "vpn": {
- "enable": true,
- "container_id": "string",
- "auto_update": true,
- "config": {
- "allow_internet": true,
- "auth": {
- "webhook": "string",
- "cycle_accounts": true,
- "vpn_accounts": true
}
}
}, - "scheduler": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "public": true,
- "access_keys": [
- {
- "name": "string",
- "secret": "string",
- "ips": [
- null
]
}
]
}
}
}, - "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}, - "private_network": {
- "vxlan_tag": 0,
- "subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}
}
}, - "deployments": {
- "tags": {
- "property1": "v1.2.3-dev",
- "property2": "v1.2.3-dev"
}
}, - "meta": {
- "containers_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "instances_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "containers": [
- {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "image": {
- "id": "651586fca6078e98982dbd90",
- "service": "discovery"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string",
- "container_subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": null,
- "cidr": null
}
}
}
}
]
}
}
}
Gets all the available monitoring tiers that can be enabled for an environment.
A list of monitoring tiers.
General error response from the platform
{- "data": {
- "property1": {
- "enabled": true,
- "metrics": {
- "service_granularity": "72h45m2s",
- "container_telemetry_granularity": "72h45m2s",
- "retention_period": "72h45m2s",
- "downsample_period": "72h45m2s",
- "custom": true
}, - "events": {
- "retention_period": "72h45m2s",
- "custom": true
}, - "logs": {
- "analysis": true,
- "aggregation": true,
- "custom": true
}, - "tracking_interval": "72h45m2s",
- "cost_mills": 0
}, - "property2": {
- "enabled": true,
- "metrics": {
- "service_granularity": "72h45m2s",
- "container_telemetry_granularity": "72h45m2s",
- "retention_period": "72h45m2s",
- "downsample_period": "72h45m2s",
- "custom": true
}, - "events": {
- "retention_period": "72h45m2s",
- "custom": true
}, - "logs": {
- "analysis": true,
- "aggregation": true,
- "custom": true
}, - "tracking_interval": "72h45m2s",
- "cost_mills": 0
}
}
}
Requires the environments-view
capability.
Returns an Environment.
General error response from the platform
{- "data": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "name": "string",
- "cluster": "string",
- "about": {
- "description": "string",
- "favorite": true
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "features": {
- "legacy_networking": true,
- "monitoring": {
- "tier": "limited"
}
}, - "services": {
- "loadbalancer": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "ipv4": true,
- "ipv6": true,
- "type": "v1",
- "details": {
- "controllers": [
- {
- "identifier": null,
- "port": null,
- "waf": null,
- "transport": { }
}
], - "controller_template": {
- "identifier": "string",
- "port": 0,
- "waf": {
- "rules": [ ]
}, - "transport": {
- "disable": null,
- "mode": null,
- "config": { },
- "routers": [ ]
}
}, - "waf": {
- "rules": [
- { }
]
}
}, - "bind_host": true
}
}, - "discovery": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "empty_set_delay": "72h45m2s",
- "hosts": {
- "property1": {
- "ipv4": [
- null
], - "ipv6": [
- null
]
}, - "property2": {
- "ipv4": [
- null
], - "ipv6": [
- null
]
}
}
}
}, - "vpn": {
- "enable": true,
- "container_id": "string",
- "auto_update": true,
- "config": {
- "allow_internet": true,
- "auth": {
- "webhook": "string",
- "cycle_accounts": true,
- "vpn_accounts": true
}
}
}, - "scheduler": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "public": true,
- "access_keys": [
- {
- "name": "string",
- "secret": "string",
- "ips": [
- null
]
}
]
}
}
}, - "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}, - "private_network": {
- "vxlan_tag": 0,
- "subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}
}
}, - "deployments": {
- "tags": {
- "property1": "v1.2.3-dev",
- "property2": "v1.2.3-dev"
}
}, - "meta": {
- "containers_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "instances_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "containers": [
- {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "image": {
- "id": "651586fca6078e98982dbd90",
- "service": "discovery"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string",
- "container_subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": null,
- "cidr": null
}
}
}
}
]
}
}, - "includes": {
- "creators": {
- "accounts": {
- "property1": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}, - "property2": {
- "name": {
- "first": "string",
- "last": "string"
}, - "email": {
- "address": "string"
}, - "id": "string",
- "events": {
- "property1": "2021-01-30T08:30:00Z",
- "property2": "2021-01-30T08:30:00Z",
- "last_login": "2021-01-30T08:30:00Z"
}
}
}, - "employees": null,
- "visitors": null,
- "environments": null,
- "api_keys": null
}
}
}
Updates the specificed Environment.
Requires the environments-manage
capability.
Parameters for updating an Environment.
Returns an Environment.
General error response from the platform
{- "name": "string",
- "identifier": "string",
- "version": "string",
- "about": {
- "description": "string",
- "favorite": true
}, - "monitoring": {
- "tier": "limited"
}
}
{- "data": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "name": "string",
- "cluster": "string",
- "about": {
- "description": "string",
- "favorite": true
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "features": {
- "legacy_networking": true,
- "monitoring": {
- "tier": "limited"
}
}, - "services": {
- "loadbalancer": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "ipv4": true,
- "ipv6": true,
- "type": "v1",
- "details": {
- "controllers": [
- {
- "identifier": null,
- "port": null,
- "waf": null,
- "transport": { }
}
], - "controller_template": {
- "identifier": "string",
- "port": 0,
- "waf": {
- "rules": [ ]
}, - "transport": {
- "disable": null,
- "mode": null,
- "config": { },
- "routers": [ ]
}
}, - "waf": {
- "rules": [
- { }
]
}
}, - "bind_host": true
}
}, - "discovery": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "empty_set_delay": "72h45m2s",
- "hosts": {
- "property1": {
- "ipv4": [
- null
], - "ipv6": [
- null
]
}, - "property2": {
- "ipv4": [
- null
], - "ipv6": [
- null
]
}
}
}
}, - "vpn": {
- "enable": true,
- "container_id": "string",
- "auto_update": true,
- "config": {
- "allow_internet": true,
- "auth": {
- "webhook": "string",
- "cycle_accounts": true,
- "vpn_accounts": true
}
}
}, - "scheduler": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "public": true,
- "access_keys": [
- {
- "name": "string",
- "secret": "string",
- "ips": [
- null
]
}
]
}
}
}, - "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}, - "private_network": {
- "vxlan_tag": 0,
- "subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}
}
}, - "deployments": {
- "tags": {
- "property1": "v1.2.3-dev",
- "property2": "v1.2.3-dev"
}
}, - "meta": {
- "containers_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "instances_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "containers": [
- {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "image": {
- "id": "651586fca6078e98982dbd90",
- "service": "discovery"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string",
- "container_subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": null,
- "cidr": null
}
}
}
}
]
}
}
}
Requires the environments-manage
capability.
Returns a Job Descriptor.
General error response from the platform
{- "data": {
- "action": "string",
- "job": {
- "id": "string",
- "accepted": true,
- "queue": "string",
- "schedule": "2021-01-30T08:30:00Z",
- "parallel": {
- "sub_queue": "string",
- "tasks": true
}, - "tasks": [
- {
- "caption": "string",
- "header": "string",
- "steps": [
- {
- "caption": "string",
- "description": "string",
- "started": "2021-01-30T08:30:00Z",
- "completed": "2021-01-30T08:30:00Z"
}
], - "input": {
- "property1": null,
- "property2": null
}
}
]
}
}
}
Updates the specificed Environment.
Requires the environments-manage
capability. If an ACL is present, requires the manage
privilege.
Returns an Environment.
General error response from the platform
{- "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}
}
{- "data": {
- "id": "651586fca6078e98982dbd90",
- "identifier": "string",
- "name": "string",
- "cluster": "string",
- "about": {
- "description": "string",
- "favorite": true
}, - "creator": {
- "id": "651586fca6078e98982dbd90",
- "type": "account"
}, - "hub_id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "events": {
- "created": "2021-01-30T08:30:00Z",
- "updated": "2021-01-30T08:30:00Z",
- "deleted": "2021-01-30T08:30:00Z"
}, - "features": {
- "legacy_networking": true,
- "monitoring": {
- "tier": "limited"
}
}, - "services": {
- "loadbalancer": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "ipv4": true,
- "ipv6": true,
- "type": "v1",
- "details": {
- "controllers": [
- {
- "identifier": null,
- "port": null,
- "waf": null,
- "transport": { }
}
], - "controller_template": {
- "identifier": "string",
- "port": 0,
- "waf": {
- "rules": [ ]
}, - "transport": {
- "disable": null,
- "mode": null,
- "config": { },
- "routers": [ ]
}
}, - "waf": {
- "rules": [
- { }
]
}
}, - "bind_host": true
}
}, - "discovery": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "empty_set_delay": "72h45m2s",
- "hosts": {
- "property1": {
- "ipv4": [
- null
], - "ipv6": [
- null
]
}, - "property2": {
- "ipv4": [
- null
], - "ipv6": [
- null
]
}
}
}
}, - "vpn": {
- "enable": true,
- "container_id": "string",
- "auto_update": true,
- "config": {
- "allow_internet": true,
- "auth": {
- "webhook": "string",
- "cycle_accounts": true,
- "vpn_accounts": true
}
}
}, - "scheduler": {
- "enable": true,
- "container_id": "string",
- "high_availability": true,
- "auto_update": true,
- "config": {
- "public": true,
- "access_keys": [
- {
- "name": "string",
- "secret": "string",
- "ips": [
- null
]
}
]
}
}
}, - "acl": {
- "roles": {
- "property1": {
- "view": true,
- "modify": true,
- "manage": true
}, - "property2": {
- "view": true,
- "modify": true,
- "manage": true
}
}
}, - "private_network": {
- "vxlan_tag": 0,
- "subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}
}
}, - "deployments": {
- "tags": {
- "property1": "v1.2.3-dev",
- "property2": "v1.2.3-dev"
}
}, - "meta": {
- "containers_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "instances_count": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "containers": [
- {
- "id": "651586fca6078e98982dbd90",
- "name": "string",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "image": {
- "id": "651586fca6078e98982dbd90",
- "service": "discovery"
}, - "environment": {
- "id": "651586fca6078e98982dbd90",
- "cluster": "string",
- "container_subnet": "string",
- "ipv6": {
- "ip": "fd00::21:0:0:0",
- "cidr": "fd00::21:0:0:0/96"
}, - "legacy": {
- "subnet": 0,
- "ipv4": {
- "ip": null,
- "cidr": null
}
}
}
}
]
}
}
}
Create a job for an Environment, such as 'start' or 'stop'.
Requires the environments-manage
capability.
Returns a Job Descriptor.
General error response from the platform
{- "action": "start"
}
{- "data": {
- "action": "string",
- "job": {
- "id": "string",
- "accepted": true,
- "queue": "string",
- "schedule": "2021-01-30T08:30:00Z",
- "parallel": {
- "sub_queue": "string",
- "tasks": true
}, - "tasks": [
- {
- "caption": "string",
- "header": "string",
- "steps": [
- {
- "caption": "string",
- "description": "string",
- "started": "2021-01-30T08:30:00Z",
- "completed": "2021-01-30T08:30:00Z"
}
], - "input": {
- "property1": null,
- "property2": null
}
}
]
}
}
}
Gets the summary of an Environment. Contains useful and relevant data/statistics that would otherwise be several separate API calls.
Requires the environments-view
capability.
Returns an environment summary object.
General error response from the platform
{- "data": {
- "id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "services": {
- "loadbalancer": {
- "enable": true,
- "container_id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "high_availability": true,
- "auto_update": true
}, - "discovery": {
- "enable": true,
- "container_id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "high_availability": true,
- "auto_update": true
}, - "vpn": {
- "enable": true,
- "container_id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "high_availability": true,
- "auto_update": true
}, - "scheduler": {
- "enable": true,
- "container_id": "651586fca6078e98982dbd90",
- "state": {
- "changed": "2021-01-30T08:30:00Z",
- "error": {
- "message": "string",
- "time": "2021-01-30T08:30:00Z"
}
}, - "high_availability": true,
- "auto_update": true
}
}, - "stats": {
- "containers": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}, - "instances": {
- "state": {
- "new": 0,
- "starting": 0,
- "running": 5,
- "stopping": 0,
- "deleting": 0,
- "deleted": 0
}, - "total": 5,
- "available": 5
}
}
}
}