Serveurs dédiés

⚡ Déploiements

[v2] Deploy

post

[Rate Limit: 40/seconds] Initiate a new deployment. A deployment is a containerized server instance of an application version running on the Edgegap platform.

Autorisations
AuthorizationstringRequis
Corps
applicationstringRequis

Name of the application that will be deployed

Example: my-app
versionstringRequis

Name of the version within the application that will be deployed

Example: 25.05.30-16.45.19-04
require_cached_locationsboolean | nullableOptionnel

Deploy faster by limiting placement to locations with cached image.

Default: false
tagsstring[]Optionnel

List of tags to associate with the deployment

Example: my-custom-tag
webhook_on_readyall ofOptionnel

Webhook to call when the deployment is ready

webhook_on_errorall ofOptionnel

Webhook to call when the deployment is in error

webhook_on_terminatedall ofOptionnel

Webhook to call when the deployment is terminated

Réponses
post
/deployments

Get a Deployment Status and Information

get

[Rate Limit: 20/second] Retrieve the information for a deployment.

Autorisations
authorizationstringRequis

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Paramètres de chemin
request_idstringRequis

Unique Identifier to keep track of your request across all Arbitrium ecosystem. It's included in the response of the app deploy, example:

93924761ccde
Réponses
200

Success

application/json
get
/v1/status/{request_id}

Stop a deployment

delete

Request to stop a Deployment, triggering a graceful shutdown (SIGTERM). Returns 200 or 202 if deployment status is not READY and not ERROR, and stops deployment once either of these statuses is reached - see Deployment Lifecycle.

Autorisations
authorizationstringRequis

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Paramètres de chemin
request_idstringRequis

Unique Identifier to keep track of your request across all Edgegap ecosystem. It's included in the response of the app deploy, example:

93924761ccde
Paramètres de requête
container_log_storagestringOptionnel

If you want to enable the container log storage for the deployment. You can put 'true' if you already have endpoint storage associated with your deployment's app version. You can put 'false' if it is enabled by default and you want to disable it for this specific request. Or you can put the name of your endpoint storage and if it is valid we will store the container logs.

Réponses
200

Success

application/json
delete
/v1/stop/{request_id}

Delete a Deployment from inside the container

delete

Delete a deployment from the inside of a container. You should use this URL inside your deployment. The URL is injected in your deployment and can be found via the environment variable ARBITRIUM_DELETE_URL.

Paramètres de chemin
request_idstringRequis

Unique Identifier to keep track of your request across all Arbitrium ecosystem. It's included in the response of the app deploy, example:

93924761ccde
access_point_idintegerRequis

Access Point Number provided by our system

Paramètres de requête
container_log_storagestringOptionnel

If you want to enable the container log storage for the deployment. You can put 'true' if you already have endpoint storage associated with your deployment's app version. You can put 'false' if it is enabled by default and you want to disable it for this specific request. Or you can put the name of your endpoint storage and if it is valid we will store the container logs.

Paramètres d'en-tête
authorizationstringRequis

Auto Generated token. This token is injected in your deployment and can be found via the environment variable named ARBITRIUM_DELETE_TOKEN

Réponses
200

Success

application/json
delete
/v1/self/stop/{request_id}/{access_point_id}

Delete Deployments in Bulk

post

Make a bulk delete of deployments using filters. All the deployments matching the given filters will be permanently deleted.

Autorisations
authorizationstringRequis

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Corps
Réponses
post
/v1/deployments/bulk-stop

List All Deployments

get

[Rate Limit: 10/second] List all deployments.

Autorisations
authorizationstringRequis

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Paramètres de requête
querystringOptionnel

Query to filter the deployments.

Réponses
200

Success

application/json
get
/v1/deployments

List All Locations

get

List all the locations available to deploy on. You can specify an application and a version to filter out the locations that don’t have enough resources to deploy this application version.

Autorisations
authorizationstringRequis

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Paramètres de requête
appstringOptionnel

The App Name you want to filter with capacity

versionstringOptionnel

The Version Name you want to filter with capacity

typestringOptionnel

The type of the location

tagsstringOptionnel

Gets locations with tags. Set to: "true" to have the tags

Réponses
200

Success

application/json
get
/v1/locations

Get Deployment Container Logs

get

Retrieve the logs of your container. Logs are not available when your deployment is terminated. You can set up an endpoint storage to save your logs. Endpoint Storage Documentation

Autorisations
authorizationstringRequis

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Paramètres de chemin
request_idstringRequis
Réponses
200

Success

application/json
get
/v1/deployment/{request_id}/container-logs

Get a Deployment Metrics

get

Get the metrics for a specific deployment based on the start_time, end_time and steps. raw parameter can be set to true to get the raw data.

Autorisations
authorizationstringRequis

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Paramètres de chemin
request_idstringRequis
Paramètres de requête
start_timestringOptionnel

Starting time for the query. Default to deployment start time. Should match %Y-%m-%d %H:%M:%S.%f

	Example: 2021-07-10 00:00:00.00
end_timestringOptionnel

End time for the metrics. Default to now.Must be greater than start_time. Should match %Y-%m-%d %H:%M:%S.%f

	Example: 2021-07-19 00:00:00.00
stepsstringOptionnel

Steps between each metrics.

	Example: 30s, 1m, 5m 10m, 1h
rawstringOptionnel

If set to true, will return the raw data. Default to false.

Réponses
200

Success

application/json
get
/v1/metrics/deployment/{request_id}

Hérité [v1]

🗺️ Flottes privées

Deploy to Fleet

post

[Rate Limit: 40/seconds] Initiate a new private fleet deployment. A deployment is a containerized server instance of an application version running on the Edgegap platform.

Autorisations
AuthorizationstringRequis
Corps
applicationstringRequis

Name of the application that will be deployed

Example: my-app
versionstringRequis

Name of the version within the application that will be deployed

Example: 25.05.30-16.45.19-04
require_cached_locationsboolean | nullableOptionnel

Deploy faster by limiting placement to locations with cached image.

Default: false
private_host_idsstring[] · min: 1Requis

Preferred and prioritized Private Host IDs to try before overflowing to cloud.

Example: alpha-north-america-95fab093
tagsstring[]Optionnel

List of tags to associate with the deployment

Example: my-custom-tag
webhook_on_readyall ofOptionnel

Webhook to call when the deployment is ready

webhook_on_errorall ofOptionnel

Webhook to call when the deployment is in error

webhook_on_terminatedall ofOptionnel

Webhook to call when the deployment is terminated

Réponses
post
/private-fleets:deploy

List Private Fleet Hosts

get

[Rate Limit: 10/seconds] List all hosts in a private fleet.

Autorisations
AuthorizationstringRequis
Paramètres de chemin
fleet-namestringRequis

Name of your private fleet.

Example: test-fleet
Réponses
200Succès
application/json
get
/private-fleets/{fleet-name}/hosts

🔖 Étiquettes

List tags for a Deployment

get

List tags for a deployment.

Autorisations
authorizationstringRequis

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Paramètres de chemin
request_idstringRequis
Réponses
200

Success

application/json
get
/v1/deployments/{request_id}/tags

Get tag for a Deployment

get

Get tag for a deployment.

Autorisations
authorizationstringRequis

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Paramètres de chemin
request_idstringRequis
tag_namestringRequis
Réponses
200

Success

application/json
get
/v1/deployments/{request_id}/tags/{tag_name}

Create Tag for a Deployment

post

Create a tag for a deployment. The tag will however not be injected into a running container.

Autorisations
authorizationstringRequis

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Paramètres de chemin
request_idstringRequis
Corps
namestring · max: 20Requis

The name of the tag

Example: v1.0.0
Réponses
200

Success

application/json
post
/v1/deployments/{request_id}/tags

Delete Tag for a Deployment

delete

Delete a tag for a deployment. The tag will however not be removed from the environment of a running container.

Autorisations
authorizationstringRequis

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Paramètres de chemin
request_idstringRequis
tag_namestringRequis
Réponses
delete
/v1/deployments/{request_id}/tags/{tag_name}

Aucun contenu

Update Tag for a Deployment

patch

Update a tag for a deployment.

Autorisations
authorizationstringRequis

To access Edgegap API, generate (and view) your secret tokens in Dashboard - User Settings / Tokens. Add your secret token with each API request as an HTTP header (include the word token): Authorization: token xxxxxxxx-e458-4592-b607-c2c28afd8b62

Paramètres de chemin
request_idstringRequis
tag_namestringRequis
Corps
namestring · max: 20Requis

The name of the tag

Example: v1.0.0
Réponses
200

Success

application/json
patch
/v1/deployments/{request_id}/tags/{tag_name}

Mis à jour

Ce contenu vous a-t-il été utile ?