PUT
https://api.distelli.com/:username/apps/:app_name/envs/:env_name?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| app_name: required |
String The name of the application you wish to create in Pipelines. |
| env_name: required |
String The name of the environment you wish to create. |
| description: |
String A description for the created environment. |
| tags: |
Array of Strings Environment tags. |
| vars: |
Object Environment variables. |
curl -i -H "Content-Type: application/json" -X PUT "https://api.distelli.com/jdoe/apps/SimpleApp/envs/SA_Beta?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z" -d '{"description": "Beta Environment","tags": ["GOLD","DEV"],"vars": [{"name": "ALEX","value": "\"is cool\""}]}'
{
"env": {
"active_release_url": null,
"active_release_version": null,
"api_url": "https://api.distelli.com/jdoe/envs/SA_Beta",
"app_name": "SimpleApp",
"app_url": "https://api.distelli.com/jdoe/apps/SimpleApp",
"deployments_url": "https://api.distelli.com/jdoe/envs/SA_Beta/deployments",
"description": "Beta Environment",
"html_url": "https://www.distelli.com/jdoe/envs/SA_Beta",
"last_deployment": null,
"name": "SA_Beta",
"owner": "jdoe",
"server_count": 0,
"servers_url": "https://api.distelli.com/jdoe/envs/SA_Beta/servers",
"settings_url": "https://api.distelli.com/jdoe/envs/SA_Beta/settings",
"tags": [
"DEV",
"GOLD"
],
"vars": [
{
"name": "ALEX",
"value": "\"is cool\""
}
]
}
}
This API call will allow you to create a new application environment.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Application name can be found:
Enter a unique name for your new environment.
Enter a string for your new application environment description.
{
"description": "This is a description"
}
Environment tags are an array of strings and must not contain more than three tags.
{
"tags": [
"DEV",
"GOLD"
]
}
Environment variables must be specified as an array of objects. Each object has two pairs; name and value.
{
"vars": [
{
"name": "JAVA_HOME",
"value": "\"/usr/lib/jvm/default-java/jre\""
},
{
"name": "TEST",
"value": "\"Deploy to test\""
}
]
}
DELETE
https://api.distelli.com/:username/envs/:env_name?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The name of the application environment you wish to delete in Pipelines. |
curl -i -X DELETE -H "Content-Type: application/json"
"https://api.distelli.com/jdoe/envs/app1-beta?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z"
NO RESULTS ON SUCCESS
This API call will allow you to delete an application environment in your Pipelines account.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
DELETE
https://api.distelli.com/:username/envs/:env_name/vars?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The name of the application environmnet whose variables you wish to delete. |
curl -i -X DELETE -H "Content-Type: application/json" "https://api.distelli.com/jdoe/envs/SA_Beta/vars?apiToken=abcdefghijklmnopqrstuvwxyz0123456789"
{
"vars":[
{
"name":"JAVA_HOME",
"value":"\"/usr/bin/jre\""
}
]
}
This API call will delete all environment variables from an application environment.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
POST
https://api.distelli.com/:username/envs/:env_name/deploy?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The name of the application environment you wish to deploy to. |
| release_version: required |
String The application release version you wish to deploy. |
| description: |
String The description for the deploy. |
| sync_only: |
Boolean If true, deploys the release only to servers in the environment that do not currently have that release. |
| stagger_size: |
Integer The number of servers to deploy to at a time. |
| stagger_delay: |
Integer The delay to wait between deploys. |
curl -i -H "Content-Type: application/json" -X POST "https://api.distelli.com/jdoe/envs/SA_Linux/deploy?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z" -d '{"release_version": "v76","description": "Deploying release 76","stagger_size": 4,"stagger_delay": 14}'
{
"deployment": {
"api_url": "https://api.distelli.com/jdoe/deployments/37439",
"app_name": "SimpleApp",
"app_url": "https://api.distelli.com/jdoe/apps/SimpleApp",
"deployer": "jdoe",
"deployment_id": "d-g6ypsiqe0t5b5208f23d",
"deployment_number": "37439",
"deployment_state": "InProgress",
"deployment_time": "2015-09-15T00:04:46Z",
"deployment_type": "Deploy",
"env_name": "SA_Linux",
"env_url": "https://api.distelli.com/jdoe/envs/SA_Linux",
"html_url": "https://www.distelli.com/jdoe/deployments/37439",
"release_url": "https://api.distelli.com/jdoe/apps/SimpleApp/releases/v76",
"release_version": "v76",
"servers": {
"done": 0,
"failed": 0,
"in_progress": 0,
"pending": 0,
"waiting": 1
},
"servers_url": "https://api.distelli.com/jdoe/deployments/d-g6ypsiqe0t5b5208f23d/servers",
"stagger_delay": 14,
"stagger_size": 4
}
}
This API call will allow you to add or remove servers from an application environment. While adding servers you can specify to also deploy a release to the newly added servers.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
The application release version that you wish to deploy to the environment.
{
"release_version": "v76"
}
Enter a description string for the deploy.
{
"description": "This is a description"
}
If true, deploy the release to servers in the environment that do not currently have that release.
{
"sync_only": true
}
The number of servers to deploy to at a time.
{
"stagger_size": 2
}
The delay to wait, in seconds, between deploys.
{
"stagger_size": 15
}
PATCH
https://api.distelli.com/:username/envs/:env_name/servers?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The Pipelines application environment you wish to edit server membership. |
| servers: required |
Array of Strings A comma-separated list of server IDs that you wish to add or remove. |
| action: required |
String Whether you want to add or remove the servers from the environment. |
| deploy: |
Boolean true | false, do you want to deploy to the servers. |
| description: |
String The description for the deploy, if true. |
| stagger_size: |
Integer The number of servers to deploy to at a time. |
| stagger_delay: |
Integer The delay to wait between deploys. |
| abort_threshold: |
Integer Fail and abort the deploy if abort_threshold servers fail. |
| release_version: |
String The application release version you wish to deploy. |
curl -i -X PATCH -H "Content-Type: application/json" "https://api.distelli.com/jdoe/envs/SA_Linux/servers?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z" -d {"servers": ["766b88c8-e925-11e4-ae8b-080027cc07f7","a4d253a3-1668-e64b-86be-122d4227c561"],"action": "add","deploy": true,"description": "zDescriptionz","stagger_size": 3,"stagger_delay": 15,"release_version": "v76"}
{
"deployment": {
"api_url": "https://api.distelli.com/jdoe/deployments/37448",
"app_name": "SimpleApp",
"app_url": "https://api.distelli.com/jdoe/apps/SimpleApp",
"deployer": "jdoe",
"deployment_id": "d-mam4l51gg8e6d4beb8c",
"deployment_number": "37448",
"deployment_state": "InProgress",
"deployment_time": "2015-09-15T00:21:49Z",
"deployment_type": "Deploy",
"env_name": "SA_Linux",
"env_url": "https://api.distelli.com/jdoe/envs/SA_Linux",
"html_url": "https://www.distelli.com/jdoe/deployments/37448",
"release_url": "https://api.distelli.com/jdoe/apps/SimpleApp/releases/v76",
"release_version": "v76",
"servers": {
"done": 0,
"failed": 0,
"in_progress": 0,
"pending": 0,
"waiting": 2
},
"servers_url": "https://api.distelli.com/jdoe/deployments/d-mam4l51gg8e6d4beb8c/servers",
"stagger_delay": 15,
"stagger_size": 3
},
"release": {
"api_url": "https://api.distelli.com/jdoe/apps/SimpleApp/releases/v76",
"app_name": "SimpleApp",
"build_num": null,
"build_url": null,
"created": "2015-09-02T15:00:37Z",
"created_by": "jdoe",
"description": null,
"html_url": "https://www.distelli.com/jdoe/releases/a-y9hz57fmny866e948b65",
"release_version": "v76",
"tags": [
"abc"
]
},
"servers": [
{
"agent_version": "3.38",
"api_url": "https://api.distelli.com/jdoe/servers/a4d253a3-1668-e64b-86be-122d4227c561",
"cloud_instance_id": "i-bcbe3a1f",
"cloud_location": "us-east-1",
"cloud_provider": "Aws",
"dns_name": "ip-172-30-1-250",
"html_url": "https://www.distelli.com/jdoe/servers/a4d253a3-1668-e64b-86be-122d4227c561",
"ip_addr": "172.30.1.250",
"is_healthy": "false",
"mac_address": "12:2d:42:27:c5:61",
"os_name": "Linux",
"os_version": "3.14.48-33.39.amzn1.x86_64",
"server_id": "a4d253a3-1668-e64b-86be-122d4227c561",
"start_time": "2015-09-11T17:05:59Z",
"tags": [
"EC2"
]
},
{
"agent_version": "3.35",
"api_url": "https://api.distelli.com/jdoe/servers/766b88c8-e925-11e4-ae8b-080027cc07f7",
"cloud_instance_id": null,
"cloud_location": null,
"cloud_provider": null,
"dns_name": "serverA",
"html_url": "https://www.distelli.com/jdoe/servers/766b88c8-e925-11e4-ae8b-080027cc07f7",
"ip_addr": "192.168.1.112",
"is_healthy": "true",
"mac_address": "08:00:27:cc:07:f7",
"os_name": "Ubuntu",
"os_version": "14.04",
"server_id": "766b88c8-e925-11e4-ae8b-080027cc07f7",
"start_time": "2015-09-14T19:10:06Z",
"tags": null
}
]
}
This API call will allow you to add or remove servers from an application environment in Pipelines. While adding servers you can specify to also deploy a release to the newly added servers.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
Servers is an array of server_id(s).
{
"5eab3056-8529-964a-811e-0800277a90a4",
"a4d253a3-1668-e64b-86be-122d4227c561"
}
Server ID can be found:
Action specifies whether you wish to add or remove the servers from the environment.
{
"action": "add"
}
| true | false, do you want to deploy to the newly added servers or terminate to the newly removed servers. |
{
"deploy": true
}
Enter a description string for the deploy.
{
"description": "This is a description"
}
The number of servers to deploy to at a time.
{
"stagger_size": 2
}
The delay to wait, in seconds, between deploys.
{
"stagger_delay": 15
}
In a large deploy, fail and abort the rest of the deploy if abort_threshold number of servers fail.
{
"abort_threshold": 5
}
The application release version that you wish to deploy on adding servers.
{
"release_version": "v76"
}
PATCH
https://api.distelli.com/:username/envs/:env_name/settings?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The name of the environment you wish to edit settings. |
| abort_threshold: |
Integer Fail and abort the deploy if abort_threshold servers fail. |
| auto_deploy: |
Boolean Should servers that join this environment via distelli.yml auto deploy the active release. |
| stagger_size: |
Integer The number of servers to deploy to at a time. |
| stagger_delay: |
Integer The delay to wait between deploys. |
curl -i -H "Content-Type: application/json" -X PATCH "https://api.distelli.com/jdoe/envs/a7/settings?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z" -d '{"auto_deploy": false,"stagger_size": 2,"stagger_delay": 20,"abort_threshold": 1}'
{
"env_name":"a7",
"settings":{
"abort_threshold":1,
"auto_deploy":false,
"stagger_delay":20,
"stagger_size":2
}
}
This API call will allow you to set an environment’s settings.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
Enter a boolean true | false whether when servers join this environment via an automated distelli.yml should they deploy the active release.
Enter an integer for your abort threshold. This defines the number of servers to fail in a deploy before the balance of servers are aborted.
{
"abort_threshold": 10
}
The number of servers to deploy to at a time.
{
"stagger_size": 2
}
The delay to wait, in seconds, between deploys.
{
"stagger_size": 15
}
PATCH
https://api.distelli.com/:username/envs/:env_name/tags?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The Pipelines application environment you wish to edit server membership. |
| tags: required |
Array of Strings A comma-separated list of tags that you wish to add or remove. |
| action: required |
String Whether you want to add or remove the tag(s) from the environment. |
curl -i -X PATCH -H "Content-Type: application/json" "https://api.distelli.com/jdoe/envs/SA_Linux/tags?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z" -d '{"tags": ["TAG1","TAG2"],"action": "add"}'
{
"tags":[
"TAG1",
"TAG2"
]
}
This API call will allow you to add or remove tags from an application environment in Pipelines.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
Tags is an array of tag(s).
{
"tags": [
"TAG1",
"TAG2"
]
}
Action specifies whether you wish to add or remove the servers from the environment.
{
"action": "add"
}
GET
https://api.distelli.com/:username/envs/:env_name?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The name of the application environment you wish to view. |
curl -i "https://api.distelli.com/jdoe/envs/SA_Linux?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z"
{
"env":{
"active_release_url":"https://api.distelli.com/jdoe/apps/simpleapp/releases/v15",
"active_release_version":"v15"
"api_url":"https://api.distelli.com/jdoe/envs/SA_Linux",
"app_name":"SimpleApp",
"app_url":"https://api.distelli.com/jdoe/apps/SimpleApp",
"deployments_url":"https://api.distelli.com/jdoe/envs/SA_Linux/deployments",
"description":"This is SA_Linux Description.",
"html_url":"https://www.distelli.com/jdoe/envs/SA_Linux",
"last_deployment":null,
"name":"SA_Linux",
"owner":"jdoe",
"server_count":2,
"servers_url":"https://api.distelli.com/jdoe/envs/SA_Linux/servers",
"settings_url":"https://api.distelli.com/jdoe/envs/SA_Linux/settings",
"tags":[
"GOLD",
"BETA"
],
"vars":[
{
"name":"EXAMPLE",
"value":"\"This is example variable\""
},
{
"name":"EXAMPLE2",
"value":"\"Another example\""
}
]
}
}
This API call will allow you to view a specific application environment.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
GET
https://api.distelli.com/:username/envs/:env_name/settings?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The name of the environment you wish to edit settings. |
curl -i -H "Content-Type: application/json" -X GET "https://api.distelli.com/jdoe/envs/a7/settings?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z"
{
"env_name":"a7",
"settings":{
"abort_threshold":1,
"auto_deploy":false,
"stagger_delay":20,
"stagger_size":2
}
}
This API call will allow you to set an environment’s settings.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
GET
https://api.distelli.com/:username/envs/:env_name/vars?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The Pipelinesapplication environment name in which you want to view the environment variables. |
curl -i "https://api.distelli.com/jdoe/envs/SA_Linux/vars?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z"
{
"vars": [
{
"name": "EXAMPLE",
"value": "\"This is example variable\""
},
{
"name": "EXAMPLE2",
"value": "\"Another example\""
}
]
}
This API call will allow you to view a specific application environment’s environment variables.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
GET
https://api.distelli.com/:username/apps/:app_name/envs?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| app_name: required |
String The name of your application in Pipelines you wish to list environments. |
curl -i "https://api.distelli.com/jdoe/apps/SimpleApp/envs?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z"
{
"envs": [
{
"active_release_url": null,
"active_release_version": null,
"api_url": "https://api.distelli.com/jdoe/envs/SA_Windows",
"app_name": "SimpleApp",
"app_url": "https://api.distelli.com/jdoe/apps/SimpleApp",
"deployments_url": "https://api.distelli.com/jdoe/envs/SA_Windows/deployments",
"description": null,
"html_url": "https://www.distelli.com/jdoe/envs/SA_Windows",
"last_deployment_url": null,
"name": "SA_Windows",
"owner": "jdoe",
"servers_url": "https://api.distelli.com/jdoe/envs/SA_Windows/servers",
"settings_url": "https://api.distelli.com/jdoe/envs/SA_Windows/settings",
"tags": [
"test",
"win"
],
"vars": []
},
{
"active_release_url": "https://api.distelli.com/jdoe/apps/SimpleApp/releases/76",
"active_release_version": "v76"
"api_url": "https://api.distelli.com/jdoe/envs/SA_Linux",
"app_name": "SimpleApp",
"app_url": "https://api.distelli.com/jdoe/apps/SimpleApp",
"deployments_url": "https://api.distelli.com/jdoe/envs/SA_Linux/deployments",
"description": "This is SA_Linux Description. Go Hawks",
"html_url": "https://www.distelli.com/jdoe/envs/SA_Linux",
"last_deployment_url": "https://api.distelli.com/jdoe/deployments/37363",
"name": "SA_Linux",
"owner": "jdoe",
"servers_url": "https://api.distelli.com/jdoe/envs/SA_Linux/servers",
"settings_url": "https://api.distelli.com/jdoe/envs/SA_Linux/settings",
"tags": [
"egg",
"qa"
],
"vars": [
{
"name": "EXAMPLE",
"value": "\"OVERRIDDEN\""
},
{
"name": "EXAMPLE2",
"value": "\"From WebUI!!\""
}
]
},
{
"active_release_url": null,
"active_release_version": null
"api_url": "https://api.distelli.com/jdoe/envs/TEST_SAPP",
"app_name": "SimpleApp",
"app_url": "https://api.distelli.com/jdoe/apps/SimpleApp",
"deployments_url": "https://api.distelli.com/jdoe/envs/TEST_SAPP/deployments",
"description": null,
"html_url": "https://www.distelli.com/jdoe/envs/TEST_SAPP",
"last_deployment_url": null,
"name": "TEST_SAPP",
"owner": "jdoe",
"servers_url": "https://api.distelli.com/jdoe/envs/TEST_SAPP/servers",
"settings_url": "https://api.distelli.com/jdoe/envs/TEST_SAPP/settings",
"tags": [],
"vars": [
{
"name": "EXAMPLE",
"value": "OVERRIDDEN"
}
]
}
],
"marker": null
}
This API call will allow you to list an applications environments.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Application name can be found:
This API command supports pagination and sorting. The following query string parameters can be included:
max_results - The number of results to return. The default is 10.
marker - Continue pagination from this marker.
order - Provide sorting values include: asc |
desc for ascending | descending respectively. |
For more information on pagination see Pipelines API pagination.
GET
https://api.distelli.com/:username/envs/:env_name/deployments?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The application environment you want to list deployments. |
curl -i "https://api.distelli.com/jdoe/envs/SA_Linux/deployments?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z8&max_results=2&order=desc"
{
"deployments":[
{
"api_url":"https://api.distelli.com/jdoe/deployments/37363",
"app_name":"SimpleApp",
"app_url":"https://api.distelli.com/jdoe/apps/SimpleApp",
"deployer":"jdoe",
"deployment_id":"d-06c2zta9oj81303607e4",
"deployment_number":"37363",
"deployment_state":"Ok",
"deployment_time":"2015-09-14T20:25:71Z",
"deployment_type":"Deploy",
"env_name":"SA_Linux",
"env_url":"https://api.distelli.com/jdoe/envs/SA_Linux",
"html_url":"https://www.distelli.com/jdoe/deployments/37363",
"release_url":"https://api.distelli.com/jdoe/apps/SimpleApp/releases/v76",
"release_version":"v76",
"servers":{
"done":1,
"failed":0,
"in_progress":0,
"pending":0,
"waiting":0
},
"servers_url":"https://api.distelli.com/jdoe/deployments/d-06c2zta9oj81303607e4/servers",
"stagger_delay":60,
"stagger_size":1
},
{
"api_url":"https://api.distelli.com/jdoe/deployments/37342",
"app_name":"SimpleApp",
"app_url":"https://api.distelli.com/jdoe/apps/SimpleApp",
"deployer":"jdoe",
"deployment_id":"d-y4chitp3ja13f2d843a",
"deployment_number":"37342",
"deployment_state":"Ok",
"deployment_time":"2015-09-14T19:26:54Z",
"deployment_type":"Deploy",
"env_name":"SA_Linux",
"env_url":"https://api.distelli.com/jdoe/envs/SA_Linux",
"html_url":"https://www.distelli.com/jdoe/deployments/37342",
"release_url":"https://api.distelli.com/jdoe/apps/SimpleApp/releases/v76",
"release_version":"v76",
"servers":{
"done":1,
"failed":0,
"in_progress":0,
"pending":0,
"waiting":0
},
"servers_url":"https://api.distelli.com/jdoe/deployments/d-y4chitp3ja13f2d843a/servers",
"stagger_delay":17,
"stagger_size":3
}
],
"marker":"1WeBXkO09XNgKVTjCp2Yu3UkkU4ZPDjS7mWqEhIHIuU="
}
This API call will allow you to list an application’s environments.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
This API command supports pagination and sorting. The following query string parameters can be included:
max_results - The number of results to return. The default is 10.
marker - Continue pagination from this marker.
order - Provide sorting values include: asc |
desc for ascending | descending respectively. |
For more information on pagination see Pipelines API pagination.
GET
https://api.distelli.com/:username/envs?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
curl -i "https://api.distelli.com/jdoe/envs?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z&max_results=2&order=desc"
{
"envs":[
{
"active_release_url":null,
"active_release_version":null,
"api_url":"https://api.distelli.com/jdoe/envs/zzz",
"app_name":"testapp3",
"app_url":"https://api.distelli.com/jdoe/apps/testapp3",
"deployments_url":"https://api.distelli.com/jdoe/envs/zzz/deployments",
"description":null,
"html_url":"https://www.distelli.com/jdoe/envs/zzz",
"last_deployment_url":null,
"name":"zzz",
"owner":"jdoe",
"servers_url":"https://api.distelli.com/jdoe/envs/zzz/servers",
"settings_url":"https://api.distelli.com/jdoe/envs/zzz/settings",
"tags":[
],
"vars":[
]
},
{
"active_release_url":null,
"active_release_version":null,
"api_url":"https://api.distelli.com/jdoe/envs/wordpress-prod",
"app_name":"wordpress",
"app_url":"https://api.distelli.com/jdoe/apps/wordpress",
"deployments_url":"https://api.distelli.com/jdoe/envs/wordpress-prod/deployments",
"description":null,
"html_url":"https://www.distelli.com/jdoe/envs/wordpress-prod",
"last_deployment_url":null,
"name":"wordpress-prod",
"owner":"jdoe",
"servers_url":"https://api.distelli.com/jdoe/envs/wordpress-prod/servers",
"settings_url":"https://api.distelli.com/jdoe/envs/wordpress-prod/settings",
"tags":[
],
"vars":[
]
}
],
"marker":"8/vmwqkNB8Fq7IaCuwZ8YA=="
}
This API call will allow you to list an applications environments.
Your Pipelines username can be found:
Your Pipelines API token can be found:
This API command supports pagination and sorting. The following query string parameters can be included:
max_results - The number of results to return. The default is 10.
marker - Continue pagination from this marker.
order - Provide sorting values include: asc |
desc for ascending | descending respectively. |
For more information on pagination see Pipelines API pagination.
GET
https://api.distelli.com/:username/envs/:env_name/servers?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The application environment you wish to list servers. |
curl -i "https://api.distelli.com/jdoe/envs/SA_Linux/servers?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z"
{
"marker": null,
"servers": [
{
"agent_version": "3.35",
"api_url": "https://api.distelli.com/jdoe/servers/766b88c8-e925-11e4-ae8b-080027cc07f7",
"cloud_instance_id": null,
"cloud_location": null,
"cloud_provider": null,
"dns_name": "serverA",
"html_url": "https://www.distelli.com/jdoe/servers/766b88c8-e925-11e4-ae8b-080027cc07f7",
"ip_addr": "192.168.1.112",
"is_healthy": "true",
"mac_address": "08:00:27:cc:07:f7",
"os_name": "Ubuntu",
"os_version": "14.04",
"server_id": "766b88c8-e925-11e4-ae8b-080027cc07f7",
"start_time": "2015-09-14T19:10:06Z",
"tags": null
},
{
"agent_version": "3.38",
"api_url": "https://api.distelli.com/jdoe/servers/a4d253a3-1668-e64b-86be-122d4227c561",
"cloud_instance_id": "i-bcbe3a1f",
"cloud_location": "us-east-1",
"cloud_provider": "Aws",
"dns_name": "ip-172-30-1-250",
"html_url": "https://www.distelli.com/jdoe/servers/a4d253a3-1668-e64b-86be-122d4227c561",
"ip_addr": "172.30.1.250",
"is_healthy": "false",
"mac_address": "12:2d:42:27:c5:61",
"os_name": "Linux",
"os_version": "3.14.48-33.39.amzn1.x86_64",
"server_id": "a4d253a3-1668-e64b-86be-122d4227c561",
"start_time": "2015-09-11T17:05:59Z",
"tags": [
"EC2"
]
}
]
}
This API call will allow you to list an applications environments.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
This API command supports pagination and sorting. The following query string parameters can be included:
max_results - The number of results to return. The default is 10.
marker - Continue pagination from this marker.
order - Provide sorting values include: asc |
desc for ascending | descending respectively. |
For more information on pagination see Pipelines API pagination.
POST
https://api.distelli.com/:username/envs/:env_name/restart?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The name of the application environment you wish to deploy to. |
| description: |
String The description for the deploy. |
| stagger_size: |
Integer The number of servers to deploy to at a time. |
| stagger_delay: |
Integer The delay to wait between deploys. |
curl -i -X POST -H "Content-Type: application/json" "https://api.distelli.com/jdoe/envs/SA_Linux/restart?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z" -d '{"description": "This is a Description","stagger_size": "7","stagger_delay": "13"}'
{
"deployment": {
"api_url": "https://api.distelli.com/jdoe/deployments/37551",
"app_name": "SimpleApp",
"app_url": "https://api.distelli.com/jdoe/apps/SimpleApp",
"deployer": "jdoe",
"deployment_id": "d-ja1bk2qqao93537f1032",
"deployment_number": "37551",
"deployment_state": "InProgress",
"deployment_time": "2015-09-15T16:44:16Z",
"deployment_type": "Restart",
"env_name": "SA_Linux",
"env_url": "https://api.distelli.com/jdoe/envs/SA_Linux",
"html_url": "https://www.distelli.com/jdoe/deployments/37551",
"release_url": null,
"release_version": null,
"servers": {
"done": 0,
"failed": 0,
"in_progress": 0,
"pending": 0,
"waiting": 2
},
"servers_url": "https://api.distelli.com/jdoe/deployments/d-ja1bk2qqao93537f1032/servers",
"stagger_delay": 13,
"stagger_size": 7
}
}
This API call will allow you to queue a restart deploy of an application environment.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
Enter a description string for the deploy.
{
"description": "This is a description"
}
The number of servers to deploy to at a time.
{
"stagger_size": 2
}
The delay to wait, in seconds, between deploys.
{
"stagger_size": 15
}
PUT
https://api.distelli.com/:username/envs/:env_name/release/:release_version?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The name of the application environment you wish to deploy to. |
| release_version: required |
String The application release version you wish to make active for this environment. |
curl -i -X PUT -H "Content-Type: application/json" "https://api.distelli.com/jdoe/envs/bash-test/release/v9?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z"
{
"env":{
"active_release_url":"https://api.distelli.com/jdoe/apps/BashTestApp/releases/v9",
"active_release_version":"v9"
"api_url":"https://api.distelli.com/jdoe/envs/bash-test",
"app_name":"BashTestApp",
"app_url":"https://api.distelli.com/jdoe/apps/BashTestApp",
"deployments_url":"https://api.distelli.com/jdoe/envs/bash-test/deployments",
"description":null,
"html_url":"https://www.distelli.com/jdoe/envs/bash-test",
"last_deployment_url":null,
"name":"bash-test",
"owner":"jdoe",
"server_count":2,
"servers_url":"https://api.distelli.com/jdoe/envs/bash-test/servers",
"settings_url":"https://api.distelli.com/jdoe/envs/bash-test/settings",
"tags":[
],
"vars":[
{
"name":"test1",
"value":"test"
},
{
"name":"test2",
"value":"test"
},
]
}
}
This API call will allow you to set the current active release for an environment.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
The application release version that you wish to set as the active release for the environment.
Release ID can be found:
PUT
https://api.distelli.com/:username/envs/:env_name/vars?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The name of the application environment you wish to deploy to. |
| vars: required |
Object The environment environment variables.. |
curl -i -X PUT -H "Content-Type: application/json" "https://api.distelli.com/jdoe/envs/SA_Linux/vars?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z" -d '{"vars": [{"name": "NAME1","value": "Value1"},{"name": "VARIABLE2","value": "Var2 value"}]}'
{
"vars":[
{
"name":"NAME1",
"value":"Value1"
},
{
"name":"VARIABLE2",
"value":"Var2 value"
}
]
}
This API call will allow you to set an application environments environment variables. The order of the environment variables is relevant.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
Specify environment variables as an array of objects. Each object has two pairs, name and value.
{
"vars": [
{
"name": "EXAMPLE",
"value": "\"This is example variable\""
},
{
"name": "JAVA_HOME",
"value": "\"/usr/local/jre\""
}
]
}
POST
https://api.distelli.com/:username/envs/:env_name/terminate?apiToken=:apiToken
| username: required |
String Your Pipelines user name. |
| apiToken: required |
String Your Pipelines API token. |
| env_name: required |
String The name of the application environment you wish to deploy to. |
| description: |
String The description for the deploy. |
| stagger_size: |
Integer The number of servers to deploy to at a time. |
| stagger_delay: |
Integer The delay to wait between deploys. |
curl -i -X POST -H "Content-Type: application/json" "https://api.distelli.com/jdoe/envs/SA_Linux/terminate?apiToken=abcdefghijklmnopqrstuvwxyz0123456789z" -d '{"description": "This is a Description","stagger_size": "2","stagger_delay": "29"}'
{
"deployment": {
"api_url": "https://api.distelli.com/jdoe/deployments/37553",
"app_name": "SimpleApp",
"app_url": "https://api.distelli.com/jdoe/apps/SimpleApp",
"deployer": "jdoe",
"deployment_id": "d-i3n5u1v9g2a6bf6f77cd",
"deployment_number": "37553",
"deployment_state": "InProgress",
"deployment_time": "2015-09-15T16:50:12Z",
"deployment_type": "Terminate",
"env_name": "SA_Linux",
"env_url": "https://api.distelli.com/jdoe/envs/SA_Linux",
"html_url": "https://www.distelli.com/jdoe/deployments/37553",
"release_url": null,
"release_version": null,
"servers": {
"done": 0,
"failed": 0,
"in_progress": 0,
"pending": 0,
"waiting": 2
},
"servers_url": "https://api.distelli.com/jdoe/deployments/d-i3n5u1v9g2a6bf6f77cd/servers",
"stagger_delay": 29,
"stagger_size": 2
}
}
This API call will allow you to enqueue a restart deploy of an application in an application environment.
Your Pipelines username can be found:
Your Pipelines API token can be found:
Environment name can be found:
Enter a description string for the deploy.
{
"description": "This is a description"
}
The number of servers to deploy to at a time.
{
"stagger_size": 2
}
The delay to wait, in seconds, between deploys.
{
"stagger_size": 15
}