Get Service Status

curl --request GET \
  --url https://sdk.localops.co/v1/environments/{envId}/services/{serviceId} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "message": "success",
  "data": {
    "state": "running",
    "run_status": "Running",
    "ready_count": 2,
    "svc_alias": "checkout-a1b2c3d4",
    "namespace_name": "checkout-a1b2c3d4",
    "ip_whitelist": [
      "10.0.0.0/8"
    ],
    "ops_dependencies": [
      {
        "id": "orders-primary",
        "kind": "rds",
        "exports": {
          "DATABASE_URL": "$dsn",
          "DB_HOST": "$address"
        }
      }
    ],
    "kube_secret": "checkout-a1b2c3d4-secret",
    "service": {
      "id": "b1f0a9c2-0000-0000-0000-000000000000",
      "name": "checkout api",
      "type": "web",
      "state": "running",
      "run_status": "Running",
      "ready_count": 2,
      "source": "helm_chart",
      "subdomain": "chec-a1b2c3d4",
      "kube_svc_alias": "checkout-a1b2c3d4",
      "namespace_name": "checkout-a1b2c3d4",
      "ip_whitelist": [
        "10.0.0.0/8"
      ],
      "ops_dependencies": [
        {
          "id": "orders-primary",
          "kind": "rds",
          "exports": {
            "DATABASE_URL": "$dsn",
            "DB_HOST": "$address"
          }
        }
      ],
      "kube_secret": "checkout-a1b2c3d4-secret",
      "origin": "https://chec-a1b2c3d4.production-a1b2.localops.co"
    }
  }
}

Services

Get Service Status

Poll a service’s runtime status. This is the only endpoint that hydrates live state from the environment, so kube_svc_alias, kube_secret, kube_dep_secret, kube_preview_dep_secret, namespace_name, ops_dependencies and ip_whitelist are populated here and empty or omitted everywhere else.

The service is returned twice: as a flat projection at the top of data, and in full under data.service.

The flat fields are deprecated. They are kept for existing clients and will be removed once callers read data.service. New integrations should use data.service, which names the alias kube_svc_alias and omits ip_whitelist when the service is unrestricted instead of returning null.

GET

environments

{envId}

services

{serviceId}

Get Service Status

curl --request GET \
  --url https://sdk.localops.co/v1/environments/{envId}/services/{serviceId} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "message": "success",
  "data": {
    "state": "running",
    "run_status": "Running",
    "ready_count": 2,
    "svc_alias": "checkout-a1b2c3d4",
    "namespace_name": "checkout-a1b2c3d4",
    "ip_whitelist": [
      "10.0.0.0/8"
    ],
    "ops_dependencies": [
      {
        "id": "orders-primary",
        "kind": "rds",
        "exports": {
          "DATABASE_URL": "$dsn",
          "DB_HOST": "$address"
        }
      }
    ],
    "kube_secret": "checkout-a1b2c3d4-secret",
    "service": {
      "id": "b1f0a9c2-0000-0000-0000-000000000000",
      "name": "checkout api",
      "type": "web",
      "state": "running",
      "run_status": "Running",
      "ready_count": 2,
      "source": "helm_chart",
      "subdomain": "chec-a1b2c3d4",
      "kube_svc_alias": "checkout-a1b2c3d4",
      "namespace_name": "checkout-a1b2c3d4",
      "ip_whitelist": [
        "10.0.0.0/8"
      ],
      "ops_dependencies": [
        {
          "id": "orders-primary",
          "kind": "rds",
          "exports": {
            "DATABASE_URL": "$dsn",
            "DB_HOST": "$address"
          }
        }
      ],
      "kube_secret": "checkout-a1b2c3d4-secret",
      "origin": "https://chec-a1b2c3d4.production-a1b2.localops.co"
    }
  }
}

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<uuid>

required

The unique identifier of the environment

serviceId

string<uuid>

required

The unique identifier of the service

Response

Current service status

message

string

data

object

Show child attributes

Getting Started

Endpoints

No Access Delivery

Get Service Status

Authorizations

Path Parameters

Response