Deprecated API Features
WARNING: The following API calls are deprecated and will be removed in the future.
API Call: Start Assets Update Deployment
https://api.squash.io/a/assets/start/?repository=<repository_name> HTTP Method: GET Success Response Code: 200 Success Response Body: JSON data
Sample Request
$ curl -i -H 'Squash-Key: B6mtwX0htEW0HaFp9X25UtJsiX1uBNHNsxAptnum2VxgXVwmrJfmd74En1a8MwFe' \
https://api.squash.io/a/assets/start/?repository=acme-repo
Response Sample
{"status": "ready",
"ssh_port": "6512",
"ssh_ip": "18.118.25.254",
"deployment_url": "https://cart-v2-i3fg1.squash.io",
"execution_id": "0f0d8890-ad2f-4c38-8457-b166c36bffe3",
"msg": "deployment is starting up"
}
status
has the following options: “pending”, “ready” and “error”pending
: the deployment has started successfully and is in progressready
: the deployment start up process is ready and you can now connect to the server through SSH.error
: an error message and error code are included within themsg
field
ssh_port
: only available when status isready
ssh_ip
: only available when status isready
deployment_url
: This is the Squash URL of this deployment that you can use for testingexecution_id
: This is a long unique identifier that represents an specific deployment runmsg
: Squash will display status or error messages in this field
API Call: Stop Deployment
API Specs
https://api.squash.io/a/stop/?deployment_id=<deployment_unique_id> HTTP Method: GET Success Response Code: 200 Success Response Body: JSON data
The deployment_unique_id
argument can be found in regular deployment URLs, you will also find it within the deployment_url
field of the Start Assets Update Deployment above. For more information see Squash unique deployment identifier.
Sample Request
$ curl -i -H 'Squash-Key: B6mtwX0htEW0HaFp9X25UtJsiX1uBNHNsxAptnum2VxgXVwmrJfmd74En1a8MwFe' \
https://api.squash.io/a/stop/?deployment_id=a3pgx
Response Sample
{"status":"pending", "msg":"Deployment is shutting down"}
status
has the following options: “pending”, “ready” and “error”pending
: the deployment shut down process has initiated successfully and is in progressready
: the deployment has been decommissionederror
: an error message and error code are included within themsg
field
msg
: Squash will display status or error messages in this field