Service
Retrieve Service
Getting Started
- Overview
- Installation & Running
- Quickstart: Hello Gateway
- Tutorials & Guides
Core Concepts
Traffic Management
- Rules & Forwarding
- Load Balancing
Rate Limiting & Request Control
- Rate Limiting
- Request Size Limiting
Content Security
- Overview
- NeuralTrust Guardrail
- Contextual Security
- Prompt Jailbreaks Protection
- Toxicity Detection
- Content Moderation
Application Security
Extending Functionality
Observability & Monitoring
- Prometheus
- Metric Exporters
API Reference
- Gateway
- API Key
- Upstream
- Service
- Rule
Service
Retrieve Service
Returns details of a specific service
GET
/
api
/
v1
/
gateways
/
{gateway_id}
/
services
/
{service_id}
{
"created_at": "<string>",
"credentials": {
"allow_override": true,
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>",
"azure_client_id": "<string>",
"azure_client_secret": "<string>",
"azure_tenant_id": "<string>",
"azure_use_managed_identity": true,
"gcp_service_account_json": "<string>",
"gcp_use_service_account": true,
"header_name": "<string>",
"header_value": "<string>",
"param_location": "<string>",
"param_name": "<string>",
"param_value": "<string>"
},
"description": "<string>",
"gateway_id": "<string>",
"headers": {},
"host": "<string>",
"id": "<string>",
"name": "<string>",
"path": "<string>",
"port": 123,
"protocol": "<string>",
"retries": 123,
"tags": [
"<string>"
],
"type": "<string>",
"updated_at": "<string>",
"upstream": {
"algorithm": "<string>",
"created_at": "<string>",
"gateway_id": "<string>",
"health_checks": {
"headers": {},
"interval": 123,
"passive": true,
"path": "<string>",
"threshold": 123
},
"id": "<string>",
"name": "<string>",
"tags": [
"<string>"
],
"targets": [
{
"credentials": {
"allow_override": true,
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>",
"azure_client_id": "<string>",
"azure_client_secret": "<string>",
"azure_tenant_id": "<string>",
"azure_use_managed_identity": true,
"gcp_service_account_json": "<string>",
"gcp_use_service_account": true,
"header_name": "<string>",
"header_value": "<string>",
"param_location": "<string>",
"param_name": "<string>",
"param_value": "<string>"
},
"default_model": "<string>",
"headers": {},
"host": "<string>",
"id": "<string>",
"models": [
"<string>"
],
"path": "<string>",
"port": 123,
"priority": 123,
"protocol": "<string>",
"provider": "<string>",
"tags": [
"<string>"
],
"weight": 123
}
],
"updated_at": "<string>"
},
"upstream_id": "<string>"
}
Response
200
application/json
Service details
General settings
AWS auth
Azure auth
GCP auth
Header-based auth
"query" or "body"
Parameter-based auth
Direct configuration (used when type is "direct")
Common settings
"upstream" or "endpoint"
Time in seconds before resetting failure count
Number of failures before marking as unhealthy
General settings
AWS auth
Azure auth
GCP auth
Header-based auth
"query" or "body"
Parameter-based auth
Upstream configuration (used when type is "upstream")
{
"created_at": "<string>",
"credentials": {
"allow_override": true,
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>",
"azure_client_id": "<string>",
"azure_client_secret": "<string>",
"azure_tenant_id": "<string>",
"azure_use_managed_identity": true,
"gcp_service_account_json": "<string>",
"gcp_use_service_account": true,
"header_name": "<string>",
"header_value": "<string>",
"param_location": "<string>",
"param_name": "<string>",
"param_value": "<string>"
},
"description": "<string>",
"gateway_id": "<string>",
"headers": {},
"host": "<string>",
"id": "<string>",
"name": "<string>",
"path": "<string>",
"port": 123,
"protocol": "<string>",
"retries": 123,
"tags": [
"<string>"
],
"type": "<string>",
"updated_at": "<string>",
"upstream": {
"algorithm": "<string>",
"created_at": "<string>",
"gateway_id": "<string>",
"health_checks": {
"headers": {},
"interval": 123,
"passive": true,
"path": "<string>",
"threshold": 123
},
"id": "<string>",
"name": "<string>",
"tags": [
"<string>"
],
"targets": [
{
"credentials": {
"allow_override": true,
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>",
"azure_client_id": "<string>",
"azure_client_secret": "<string>",
"azure_tenant_id": "<string>",
"azure_use_managed_identity": true,
"gcp_service_account_json": "<string>",
"gcp_use_service_account": true,
"header_name": "<string>",
"header_value": "<string>",
"param_location": "<string>",
"param_name": "<string>",
"param_value": "<string>"
},
"default_model": "<string>",
"headers": {},
"host": "<string>",
"id": "<string>",
"models": [
"<string>"
],
"path": "<string>",
"port": 123,
"priority": 123,
"protocol": "<string>",
"provider": "<string>",
"tags": [
"<string>"
],
"weight": 123
}
],
"updated_at": "<string>"
},
"upstream_id": "<string>"
}