Skip to content
BleemeoBleemeo

Retrieve a service

GET
/v1/service/{id}/
curl --request GET \
  --url https://example.com/v1/service/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \
  --header 'Authorization: Bearer <token>'

Return a single service by its ID.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

A UUID string identifying this service.

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
account
required
string format: uuid
account_config
required
string format: uuid
active
boolean
agent
string format: uuid
nullable
created_at
required
string format: date-time
events_start_at
required
string format: date-time
current_status
required
integer
current_status_text
required
string
nullable
deactivated_at
string format: date-time
nullable
display_name
string
exe_path
string
id
required
string format: uuid
instance
string
<= 250 characters
is_sandbox
required
boolean
kubernetes_cluster_name
required
string
""
label
string
<= 1000 characters
listen_addresses
string
modified_at
required
string format: date-time
monitor
boolean
monitor_ca_file
string
""
monitor_expected_content
string
""
monitor_expected_response_code
integer
nullable
monitor_headers
monitor_unexpected_content
string
""
monitor_url
string
""
monitor_head_request
boolean
monitor_domain_name
required
string
""
status_descriptions
required
Array<string>
tags
Array<object>

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
id
required
string format: uuid
is_automatic
required
boolean
is_service_tag
required
boolean
name
required
string
<= 100 characters
tag_type
  • 0 - Automatic API
  • 1 - Created by Glouton
  • 2 - Created by frontend
  • 3 - Automatic Glouton
  • 4 - Automatic API for agent’s service
  • 10 - No type
integer
>= -2147483648 <= 2147483647
Allowed values: 0 1 2 3 4 10
tag_type_text
required
string

Example 

{
  "is_sandbox": false,
  "kubernetes_cluster_name": "",
  "monitor": false,
  "monitor_ca_file": "",
  "monitor_expected_content": "",
  "monitor_unexpected_content": "",
  "monitor_url": "",
  "monitor_head_request": false,
  "monitor_domain_name": "",
  "tags": [
    {
      "tag_type": 0
    }
  ]
}