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
}
}
}
}
Exports an environment as a stack file for reuse.
Requires the environments-manage
capability. You must also have management permissions on the target environment ACL.
Returns a stack spec file.
General error response from the platform
{- "deployment_tags": [
- "string"
], - "resolve_origins": false
}
{- "data": {
- "version": "1.0",
- "about": {
- "version": "string",
- "description": "string"
}, - "scoped_variables": [
- {
- "identifier": "string",
- "scope": {
- "containers": {
- "global": true,
- "ids": [
- "string"
], - "identifiers": [
- "string"
]
}
}, - "access": {
- "env_variable": {
- "key": "string"
}, - "internal_api": {
- "duration": "72h45m2s"
}, - "file": {
- "decode": true,
- "path": "/var/run/cycle/variables/<myVariable>"
}
}, - "source": { }
}
], - "containers": {
- "property1": {
- "name": "string",
- "image": {
- "name": "string",
- "origin": {
- "type": "docker-hub",
- "details": {
- "existing": {
- "source_id": null
}, - "target": "string",
- "username": "string",
- "token": "string"
}
}, - "build": {
- "args": {
- "property1": "string",
- "property2": "string"
}
}, - "builder": {
- "integration_id": "my-image-source"
}
}, - "annotations": {
- "property1": null,
- "property2": null
}, - "stateful": true,
- "config": {
- "network": {
- "public": "enable",
- "hostname": "string",
- "ports": "80:80"
}, - "deploy": {
- "instances": 0,
- "strategy": "resource-density",
- "function": {
- "max_pool_size": 0,
- "max_shard_concurrency": 0,
- "max_runtime": "72h45m2s",
- "max_queue_time": "72h45m2s"
}, - "stateful": {
- "options": {
- "use_base_hostname": null
}
}, - "constraints": {
- "node": {
- "tags": { }
}
}, - "shutdown": {
- "graceful_timeout": "72h45m2s",
- "signals": [
- null
]
}, - "startup": {
- "delay": "72h45m2s"
}, - "update": {
- "stagger": "72h45m2s"
}, - "restart": {
- "condition": "always",
- "delay": "72h45m2s",
- "max_attempts": 0
}, - "health_check": {
- "command": "/bin/sh healthcheck.sh",
- "retries": 0,
- "interval": "72h45m2s",
- "timeout": "72h45m2s",
- "restart": true,
- "delay": "72h45m2s"
}, - "telemetry": {
- "retention": "72h45m2s",
- "interval": "72h45m2s",
- "webhook": "string",
- "disable": true
}
}, - "scaling": {
- "autoscale_group": "string",
- "instances": {
- "max": 0,
- "max_server": 0,
- "min_ttl": "72h45m2s"
}, - "window": "72h45m2s",
- "thresholds": [
- {
- "type": null,
- "details": { }
}
]
}, - "runtime": {
- "workdir": "string",
- "command": {
- "path": "string",
- "args": "string"
}, - "environment_vars": {
- "property1": "string",
- "property2": "string"
}, - "namespaces": [
- "ipc"
], - "sysctl": {
- "property1": "string",
- "property2": "string"
}, - "rlimits": {
- "property1": {
- "hard": null,
- "soft": null
}, - "property2": {
- "hard": null,
- "soft": null
}
}, - "seccomp": {
- "disable": true,
- "rules": [
- { }
]
}, - "host": {
- "expose_proc": true
}, - "privileged": true,
- "capabilities": [
- "CAP_CHOWN"
], - "rootfs": {
- "readonly": true
}
}, - "resources": {
- "cpu": {
- "shares": {
- "limit": null,
- "reserve": null
}, - "cpus": "string"
}, - "ram": {
- "limit": "string",
- "reserve": "string",
- "swappiness": 0
}
}, - "integrations": {
- "webhooks": {
- "events": {
- "deploy": null,
- "start": null,
- "stop": null
}, - "config": "string"
}, - "lets_encrypt": {
- "enable": true,
- "certificate_path": "string",
- "chain_path": "string",
- "key_path": "string",
- "bundle_path": "string",
- "additional_certs_path": "string"
}, - "files": [
- {
- "source": null,
- "destination": null
}
], - "backups": {
- "integration_id": "my-image-source",
- "backup": {
- "command": null,
- "timeout": null,
- "cron_string": null
}, - "restore": {
- "command": null,
- "timeout": null
}, - "retention": "365d"
}, - "shared_file_systems": {
- "property1": {
- "writable": null,
- "mount_point": null
}, - "property2": {
- "writable": null,
- "mount_point": null
}
}, - "logs": {
- "groups": [
- null
]
}
}
}, - "role": "conductor",
- "volumes": [
- {
- "local": {
- "max_size": "5G",
- "storage_pool": true
}, - "destination": "string",
- "read_only": true,
- "remote_access": {
- "enable": true,
- "ips": [
- null
], - "webhook": "string",
- "password": {
- "algorithm": null,
- "data": null
}
}
}
], - "deprecate": true,
- "lock": true
}, - "property2": {
- "name": "string",
- "image": {
- "name": "string",
- "origin": {
- "type": "docker-hub",
- "details": {
- "existing": {
- "source_id": null
}, - "target": "string",
- "username": "string",
- "token": "string"
}
}, - "build": {
- "args": {
- "property1": "string",
- "property2": "string"
}
}, - "builder": {
- "integration_id": "my-image-source"
}
}, - "annotations": {
- "property1": null,
- "property2": null
}, - "stateful": true,
- "config": {
- "network": {
- "public": "enable",
- "hostname": "string",
- "ports": "80:80"
}, - "deploy": {
- "instances": 0,
- "strategy": "resource-density",
- "function": {
- "max_pool_size": 0,
- "max_shard_concurrency": 0,
- "max_runtime": "72h45m2s",
- "max_queue_time": "72h45m2s"
}, - "stateful": {
- "options": {
- "use_base_hostname": null
}
}, - "constraints": {
- "node": {
- "tags": { }
}
}, - "shutdown": {
- "graceful_timeout": "72h45m2s",
- "signals": [
- null
]
}, - "startup": {
- "delay": "72h45m2s"
}, - "update": {
- "stagger": "72h45m2s"
}, - "restart": {
- "condition": "always",
- "delay": "72h45m2s",
- "max_attempts": 0
}, - "health_check": {
- "command": "/bin/sh healthcheck.sh",
- "retries": 0,
- "interval": "72h45m2s",
- "timeout": "72h45m2s",
- "restart": true,
- "delay": "72h45m2s"
}, - "telemetry": {
- "retention": "72h45m2s",
- "interval": "72h45m2s",
- "webhook": "string",
- "disable": true
}
}, - "scaling": {
- "autoscale_group": "string",
- "instances": {
- "max": 0,
- "max_server": 0,
- "min_ttl": "72h45m2s"
}, - "window": "72h45m2s",
- "thresholds": [
- {
- "type": null,
- "details": { }
}
]
}, - "runtime": {
- "workdir": "string",
- "command": {
- "path": "string",
- "args": "string"
}, - "environment_vars": {
- "property1": "string",
- "property2": "string"
}, - "namespaces": [
- "ipc"
], - "sysctl": {
- "property1": "string",
- "property2": "string"
}, - "rlimits": {
- "property1": {
- "hard": null,
- "soft": null
}, - "property2": {
- "hard": null,
- "soft": null
}
}, - "seccomp": {
- "disable": true,
- "rules": [
- { }
]
}, - "host": {
- "expose_proc": true
}, - "privileged": true,
- "capabilities": [
- "CAP_CHOWN"
], - "rootfs": {
- "readonly": true
}
}, - "resources": {
- "cpu": {
- "shares": {
- "limit": null,
- "reserve": null
}, - "cpus": "string"
}, - "ram": {
- "limit": "string",
- "reserve": "string",
- "swappiness": 0
}
}, - "integrations": {
- "webhooks": {
- "events": {
- "deploy": null,
- "start": null,
- "stop": null
}, - "config": "string"
}, - "lets_encrypt": {
- "enable": true,
- "certificate_path": "string",
- "chain_path": "string",
- "key_path": "string",
- "bundle_path": "string",
- "additional_certs_path": "string"
}, - "files": [
- {
- "source": null,
- "destination": null
}
], - "backups": {
- "integration_id": "my-image-source",
- "backup": {
- "command": null,
- "timeout": null,
- "cron_string": null
}, - "restore": {
- "command": null,
- "timeout": null
}, - "retention": "365d"
}, - "shared_file_systems": {
- "property1": {
- "writable": null,
- "mount_point": null
}, - "property2": {
- "writable": null,
- "mount_point": null
}
}, - "logs": {
- "groups": [
- null
]
}
}
}, - "role": "conductor",
- "volumes": [
- {
- "local": {
- "max_size": "5G",
- "storage_pool": true
}, - "destination": "string",
- "read_only": true,
- "remote_access": {
- "enable": true,
- "ips": [
- null
], - "webhook": "string",
- "password": {
- "algorithm": null,
- "data": null
}
}
}
], - "deprecate": true,
- "lock": true
}
}, - "services": {
- "discovery": { },
- "loadbalancer": { },
- "scheduler": { },
- "vpn": { }
}, - "annotations": {
- "property1": null,
- "property2": null
}
}
}