Kentik SyntheticsAdminService API

The SyntheticsAdminService API from Kentik — 7 operation(s) for syntheticsadminservice.

Documentation Provider Profile APIs.io OpenAPI GitHub

Kentik SyntheticsAdminService API is one of 24 APIs that Kentik publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SyntheticsAdminService. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 15 operations across 7 paths, and defines 55 schemas. It is described by OpenAPI 3.0.0, at version v202511.

Requests are made against the base URL https://grpc.api.kentik.com.

15 operations 7 paths 55 schemas 3 DELETE6 GET2 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

v202511

Base URL

https://grpc.api.kentik.com

Authentication

API Key, API Key

Contact

Kentik API Engineering

Resource Areas

Authentication & Security 2

Kentik SyntheticsAdminService API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-CH-Auth-Email (email). An API key is passed in the header as X-CH-Auth-API-Token (token). By default, every request must be authenticated.

Paths & Operations 15

Across 7 paths, the API surfaces 15 operations — 3 DELETE, 6 GET, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

SyntheticsAdminService 15

GET

/synthetics/v202309/agentAlerts

List agent alert configurations

ListAgentAlerts 1 param → 200default

POST

/synthetics/v202309/agentAlerts

Create an agent alert configuration

CreateAgentAlert body → 200default

GET

/synthetics/v202309/agentAlerts/{id}

Get an agent alert configuration

GetAgentAlert 1 param → 200default

DELETE

/synthetics/v202309/agentAlerts/{id}

Delete an agent alert configuration

DeleteAgentAlert 1 param → 200default

PUT

/synthetics/v202309/agentAlerts/{id}

Update an agent alert configuration

UpdateAgentAlert 1 param body → 200default

GET

/synthetics/v202309/agents

List available agents

ListAgents → 200default

PUT

/synthetics/v202309/agents/{agent.id}

Update configuration of an agent

UpdateAgent 1 param body → 200default

GET

/synthetics/v202309/agents/{agent.id}

Get information about an agent

GetAgent 1 param → 200default

DELETE

/synthetics/v202309/agents/{agent.id}

Delete an agent

DeleteAgent 1 param → 200default

GET

/synthetics/v202309/tests

List all tests

ListTests → 200default

POST

/synthetics/v202309/tests

Create a test

CreateTest body → 200default

GET

/synthetics/v202309/tests/{id}

Get information about a test

GetTest 1 param → 200default

DELETE

/synthetics/v202309/tests/{id}

Delete a synthetic test.

DeleteTest 1 param → 200default

PUT

/synthetics/v202309/tests/{id}

Update configuration of a test

UpdateTest 1 param body → 200default

PUT

/synthetics/v202309/tests/{id}/status

Update status of a synthetic test

SetTestStatus 1 param body → 200default

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are v202309HealthSettings (33 properties), v202309Agent (24 properties), v202309TestSettings (22 properties), v202309DisabledMetrics (12 properties). Each schema is shown below with its type and property counts.

v202309AlertingType

string

- ALERTINGTYPEUNSPECIFIED: Invalid value. - ALERTINGTYPEAGENT: Per-Agent - Generates alerts based on individual metric thresholds (This can be noisy) - ALERTIN…

v202309ActivationSettings

object

4 properties

v202309GetAgentAlertResponse

object

1 property

v202309DeleteTestResponse

object

v202309DNSRecord

string

- DNSRECORDUNSPECIFIED: Invalid value - DNSRECORDA: name to IPv4 address(es) mapping - DNSRECORDAAAA: name to IPv6 address(es) mapping - DNSRECORDCNAME: altern…

v202309Test

object

10 properties

v202309CreateTestResponse

object

1 property

v202309ListAgentAlertsResponse

object

1 property

v202309GetAgentResponse

object

1 property

v202309UpdateAgentAlertResponse

object

1 property

v202309GroupedAlertSettings

object

2 properties

v202309CreateAgentAlertResponse

object

1 property

v202309DeleteAgentAlertResponse

object

v202309ListAgentsResponse

object

2 properties

v202309ListTestsResponse

object

2 properties

v202309DnsTest

object

5 properties

v202309IpTest

object

2 properties

v202309IPFamily

string

- IPFAMILYUNSPECIFIED: Invalid value. - IPFAMILYV4: IPv4 only - IPFAMILYV6: IPv6 only - IPFAMILYDUAL: IPv4 and IPv6 supported

v202309TestThroughputSettings

object

5 properties

v202309DisabledMetrics

object

12 properties

v202309UpdateAgentResponse

object

1 property

v202309AlertingSettings

object

3 properties

v202309PageLoadTest

object

5 properties

SyntheticsAdminServiceSetTestStatusBody

object

1 property 1 required

v202309NetworkMeshTest

object

1 property

v202309FlowTest

object

7 properties

v202309TestStatus

string

- TESTSTATUSUNSPECIFIED: Invalid value. - TESTSTATUSACTIVE: Test is active. - TESTSTATUSPAUSED: Test is paused. - TESTSTATUSDELETED: Test is deleted. Not user…

v202309CreateTestRequest

object

1 property 1 required

v202309TestTraceSettings

object

8 properties

v202309AgentTest

object

3 properties

rpcStatus

object

3 properties

v202309HealthSettings

object

33 properties

v202309CreateAgentAlertRequest

object

3 properties

AgentMetadataIpValue

object

1 property

SyntheticsAdminServiceUpdateTestBody

object

1 property

v202309Agent

object

24 properties

v202309TestPingSettings

object

6 properties

v202303UserInfo

object

3 properties

v202309SetTestStatusResponse

object

v202309UrlTest

object

6 properties

v202309AgentMetadata

object

4 properties

v202309GroupedAlertSetting

object

4 properties

v202309AgentAlert

object

5 properties

v202309GetTestResponse

object

1 property

SyntheticsAdminServiceUpdateAgentBody

object

1 property

v202309HostnameTest

object

1 property

v202309DeleteAgentResponse

object

v202309SrcGroupBy

string

- SRCGROUPBYUNSPECIFIED: Invalid value. - SRCGROUPBYALLAGENTS: Grouped by all agents - SRCGROUPBYLABEL: Grouped by label - SRCGROUPBYSITE: Grouped by site

SyntheticsAdminServiceUpdateAgentAlertBody

object

2 properties

v202309ScheduleSettings

object

3 properties

v202309UpdateTestResponse

object

1 property

v202309TestSettings

object

22 properties

protobufAny

object

1 property

v202309ImplementType

string

- IMPLEMENTTYPERUST: ksynth, a.k.a network agent (implemented in Rust) capable of running all tasks except for page-load and transaction - IMPLEMENTTYPENODE: k…

v202309AgentStatus

string

- AGENTSTATUSUNSPECIFIED: Invalid value. - AGENTSTATUSOK: Agent is ready to accept tests - AGENTSTATUSWAIT: Agent is waiting for authorization - AGENTSTATUSDEL…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Kentik publishes across the network.

Kentik AiAdvisorDataService API

AE Profile APIs.io

Kentik AlertService API

AE Profile APIs.io

Kentik ASGroupService API

AE Profile APIs.io

Kentik AuditService API

AE Profile APIs.io

Kentik BgpMonitoringAdminService API

AE Profile APIs.io

Kentik BgpMonitoringDataService API

AE Profile APIs.io

Kentik CapacityPlanService API

AE Profile APIs.io

Kentik CloudExportAdminService API

AE Profile APIs.io

Kentik CostService API

AE Profile APIs.io

Kentik CustomDimensionService API

AE Profile APIs.io

Kentik DeviceService API

AE Profile APIs.io

Kentik FlowTagService API

AE Profile APIs.io

#SyntheticsAdminService

← Back to K APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Kentik SyntheticsAdminService API

Metadata

Authentication & Security 2

Paths & Operations 15

Schemas 55

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Kentik SyntheticsAdminService API

Metadata

Authentication & Security 2

Paths & Operations 15

Schemas 55

Specification

Source

More from Kentik 12

API Details

Provider

Explore more