Deploy Service

curl --request POST \
  --url https://sdk.localops.co/v1/environments/{envId}/services/{serviceId}/deploy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commit_id": "a1b2c3d4"
}
'

import requests

url = "https://sdk.localops.co/v1/environments/{envId}/services/{serviceId}/deploy"

payload = { "commit_id": "a1b2c3d4" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({commit_id: 'a1b2c3d4'})
};

fetch('https://sdk.localops.co/v1/environments/{envId}/services/{serviceId}/deploy', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sdk.localops.co/v1/environments/{envId}/services/{serviceId}/deploy"

	payload := strings.NewReader("{\n  \"commit_id\": \"a1b2c3d4\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "message": "success",
  "data": {
    "deployment_id": "3c7a4d81-0000-0000-0000-000000000000"
  }
}

Deployments

Deploy Service

Trigger a deployment for a specific service within an environment.

There are two modes. A standard deploy rolls out the service itself and returns a deployment_id you can poll. A preview deploy (preview: true) fans out to a per PR preview service and returns that service instead - preview mode does not return a deployment id.

A request body is always required. To deploy the latest commit on a git service’s configured branch, send {}.

The deployment row is created synchronously so the id comes back immediately. The rollout runs in the background and any failure there marks the deployment failed rather than failing this request.

Preview mode requires the parent service to use the github source, be of type web, have enable_previews turned on, and not itself be a preview service. The account plan must include preview environments.

If both docker_image_tag and helm_chart_version are supplied, helm_chart_version wins.

POST

environments

{envId}

services

{serviceId}

deploy

Deploy Service

curl --request POST \
  --url https://sdk.localops.co/v1/environments/{envId}/services/{serviceId}/deploy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commit_id": "a1b2c3d4"
}
'

import requests

url = "https://sdk.localops.co/v1/environments/{envId}/services/{serviceId}/deploy"

payload = { "commit_id": "a1b2c3d4" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({commit_id: 'a1b2c3d4'})
};

fetch('https://sdk.localops.co/v1/environments/{envId}/services/{serviceId}/deploy', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sdk.localops.co/v1/environments/{envId}/services/{serviceId}/deploy"

	payload := strings.NewReader("{\n  \"commit_id\": \"a1b2c3d4\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "message": "success",
  "data": {
    "deployment_id": "3c7a4d81-0000-0000-0000-000000000000"
  }
}

Authorizations

Authorization

string

header

required

Your account API token, sent as Authorization: Bearer <api_token>. Owners and admins can read the token from the LocalOps console.

Path Parameters

envId

string

required

The unique identifier of the environment

serviceId

string

required

The unique identifier of the service

Body

application/json

Deploy by Commit ID
Deploy Docker Image
Deploy Helm Chart
Preview Deployment

commit_id

string

required

The Git commit ID to deploy. Omit it, and send {}, to deploy the latest commit on the service's configured branch.

note

string

Optional note stored on the deployment

Maximum string length: 300

Response

Deployment triggered successfully

message

string

data

Standard deployment · object

Standard deployment
Preview deployment

Show child attributes

Getting Started

Endpoints

No Access Delivery

Deploy Service

Authorizations

Path Parameters

Body

Response