Services

All service endpoints require authentication via Bearer token.

List services

Retrieve all API services configured for the authenticated user.

Headers

string

required

Bearer token for authentication. Format: Bearer <jwt>

Response

Returns an array of service objects.

object[]

Show properties

number

Unique service identifier.

number

Owner user ID.

string

Service name.

string

Base URL for the service API.

string

Authentication type: api_key, bearer, basic, or oauth2.

object

Object containing credential keys (values are masked for security).

string

ISO 8601 timestamp of service creation.

string

ISO 8601 timestamp of last update.

Status codes

200 - Services retrieved successfully
401 - Unauthorized (missing or invalid token)
500 - Internal server error

curl --request GET \
  --url https://api.gaiterguard.com/services \
  --header 'Authorization: Bearer <jwt>'

const response = await fetch('https://api.gaiterguard.com/services', {
  headers: {
    'Authorization': 'Bearer <jwt>'
  }
});
const data = await response.json();

import requests

response = requests.get(
    'https://api.gaiterguard.com/services',
    headers={'Authorization': 'Bearer <jwt>'}
)
data = response.json()

[
  {
    "id": 1,
    "userId": 1,
    "name": "GitHub API",
    "baseUrl": "https://api.github.com",
    "authType": "bearer",
    "credentials": {
      "token": "***"
    },
    "createdAt": "2026-03-03T22:49:00.000Z",
    "updatedAt": "2026-03-03T22:49:00.000Z"
  }
]

Create service

Create a new service with encrypted credentials.

Headers

string

required

Bearer token for authentication. Format: Bearer <jwt>

Request body

string

required

Service name (1-255 characters).

string

required

Base URL for the service API. Must be a valid URL (max 512 characters).

string

required

Authentication type. Must be one of: api_key, bearer, basic, oauth2.

object

required

Key-value pairs of credential names and values. At least one credential is required. Values are encrypted before storage.

Response

number

Unique service identifier.

number

Owner user ID.

string

Service name.

string

Base URL for the service API.

string

Authentication type.

object

Object containing credential keys (values are masked).

string

ISO 8601 timestamp of service creation.

string

ISO 8601 timestamp of last update.

Status codes

201 - Service created successfully
400 - Validation error (invalid request body)
401 - Unauthorized (missing or invalid token)
500 - Internal server error

curl --request POST \
  --url https://api.gaiterguard.com/services \
  --header 'Authorization: Bearer <jwt>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "GitHub API",
    "baseUrl": "https://api.github.com",
    "authType": "bearer",
    "credentials": {
      "token": "ghp_xxxxxxxxxxxxx"
    }
  }'

const response = await fetch('https://api.gaiterguard.com/services', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <jwt>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'GitHub API',
    baseUrl: 'https://api.github.com',
    authType: 'bearer',
    credentials: {
      token: 'ghp_xxxxxxxxxxxxx'
    }
  })
});
const data = await response.json();

import requests

response = requests.post(
    'https://api.gaiterguard.com/services',
    headers={'Authorization': 'Bearer <jwt>'},
    json={
        'name': 'GitHub API',
        'baseUrl': 'https://api.github.com',
        'authType': 'bearer',
        'credentials': {
            'token': 'ghp_xxxxxxxxxxxxx'
        }
    }
)
data = response.json()

{
  "id": 1,
  "userId": 1,
  "name": "GitHub API",
  "baseUrl": "https://api.github.com",
  "authType": "bearer",
  "credentials": {
    "token": "***"
  },
  "createdAt": "2026-03-03T22:49:00.000Z",
  "updatedAt": "2026-03-03T22:49:00.000Z"
}

{
  "error": "At least one credential is required"
}

Get service

Retrieve a single service by ID. Ownership is verified.

Headers

string

required

Bearer token for authentication. Format: Bearer <jwt>

Path parameters

number

required

Service ID.

Response

number

Unique service identifier.

number

Owner user ID.

string

Service name.

string

Base URL for the service API.

string

Authentication type.

object

Object containing credential keys (values are masked).

string

ISO 8601 timestamp of service creation.

string

ISO 8601 timestamp of last update.

Status codes

200 - Service retrieved successfully
400 - Invalid service ID
401 - Unauthorized (missing or invalid token)
404 - Service not found
500 - Internal server error

curl --request GET \
  --url https://api.gaiterguard.com/services/1 \
  --header 'Authorization: Bearer <jwt>'

const response = await fetch('https://api.gaiterguard.com/services/1', {
  headers: {
    'Authorization': 'Bearer <jwt>'
  }
});
const data = await response.json();

import requests

response = requests.get(
    'https://api.gaiterguard.com/services/1',
    headers={'Authorization': 'Bearer <jwt>'}
)
data = response.json()

{
  "id": 1,
  "userId": 1,
  "name": "GitHub API",
  "baseUrl": "https://api.github.com",
  "authType": "bearer",
  "credentials": {
    "token": "***"
  },
  "createdAt": "2026-03-03T22:49:00.000Z",
  "updatedAt": "2026-03-03T22:49:00.000Z"
}

{
  "error": "Service not found"
}

Update service

Update service details (name, baseUrl, or authType). To update credentials, use the credentials endpoint.

Headers

string

required

Bearer token for authentication. Format: Bearer <jwt>

Path parameters

number

required

Service ID.

Request body

string

Service name (1-255 characters). Optional.

string

Base URL for the service API. Must be a valid URL (max 512 characters). Optional.

string

Authentication type. Must be one of: api_key, bearer, basic, oauth2. Optional.

At least one field must be provided for update.

Response

Returns the updated service object.

Status codes

200 - Service updated successfully
400 - Validation error (invalid service ID or request body)
401 - Unauthorized (missing or invalid token)
404 - Service not found
500 - Internal server error

curl --request PUT \
  --url https://api.gaiterguard.com/services/1 \
  --header 'Authorization: Bearer <jwt>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "GitHub Enterprise API"
  }'

const response = await fetch('https://api.gaiterguard.com/services/1', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer <jwt>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'GitHub Enterprise API'
  })
});
const data = await response.json();

import requests

response = requests.put(
    'https://api.gaiterguard.com/services/1',
    headers={'Authorization': 'Bearer <jwt>'},
    json={'name': 'GitHub Enterprise API'}
)
data = response.json()

{
  "id": 1,
  "userId": 1,
  "name": "GitHub Enterprise API",
  "baseUrl": "https://api.github.com",
  "authType": "bearer",
  "credentials": {
    "token": "***"
  },
  "createdAt": "2026-03-03T22:49:00.000Z",
  "updatedAt": "2026-03-03T23:15:00.000Z"
}

Delete service

Delete a service. This cascades to delete all associated credentials and documentation.

This action is irreversible. All agents using this service will no longer have access to it.

Headers

string

required

Bearer token for authentication. Format: Bearer <jwt>

Path parameters

number

required

Service ID.

Response

string

Success message confirming deletion.

Status codes

200 - Service deleted successfully
400 - Invalid service ID
401 - Unauthorized (missing or invalid token)
404 - Service not found
500 - Internal server error

curl --request DELETE \
  --url https://api.gaiterguard.com/services/1 \
  --header 'Authorization: Bearer <jwt>'

const response = await fetch('https://api.gaiterguard.com/services/1', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer <jwt>'
  }
});
const data = await response.json();

import requests

response = requests.delete(
    'https://api.gaiterguard.com/services/1',
    headers={'Authorization': 'Bearer <jwt>'}
)
data = response.json()

{
  "message": "Service deleted"
}

Update credentials

Replace all credentials for a service. Existing credentials are deleted and replaced with the new ones.

This replaces ALL credentials. Any credentials not included in the request will be removed.

Headers

string

required

Bearer token for authentication. Format: Bearer <jwt>

Path parameters

number

required

Service ID.

Request body

object

required

Key-value pairs of credential names and values. At least one credential is required. All values are encrypted before storage.

Response

string

Success message confirming credential update.

string[]

Array of credential key names that were stored.

Status codes

200 - Credentials updated successfully
400 - Validation error (invalid service ID or request body)
401 - Unauthorized (missing or invalid token)
404 - Service not found
500 - Internal server error

curl --request POST \
  --url https://api.gaiterguard.com/services/1/credentials \
  --header 'Authorization: Bearer <jwt>' \
  --header 'Content-Type: application/json' \
  --data '{
    "credentials": {
      "token": "ghp_newtoken123456",
      "secret": "newsecret789"
    }
  }'

const response = await fetch('https://api.gaiterguard.com/services/1/credentials', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <jwt>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    credentials: {
      token: 'ghp_newtoken123456',
      secret: 'newsecret789'
    }
  })
});
const data = await response.json();

import requests

response = requests.post(
    'https://api.gaiterguard.com/services/1/credentials',
    headers={'Authorization': 'Bearer <jwt>'},
    json={
        'credentials': {
            'token': 'ghp_newtoken123456',
            'secret': 'newsecret789'
        }
    }
)
data = response.json()

{
  "message": "Credentials updated",
  "credentialKeys": ["token", "secret"]
}

{
  "error": "At least one credential is required"
}

Authentication

Agent Endpoints

Dashboard Endpoints

Reference

List services

Headers

Response

Status codes

Create service

Headers

Request body

Response

Status codes

Get service

Headers

Path parameters

Response

Status codes

Update service

Headers

Path parameters

Request body

Response

Status codes

Delete service

Headers

Path parameters

Response

Status codes

Update credentials

Headers

Path parameters

Request body

Response

Status codes

​List services

​Headers

​Response

​Status codes

​Create service

​Headers

​Request body

​Response

​Status codes

​Get service

​Headers

​Path parameters

​Response

​Status codes

​Update service

​Headers

​Path parameters

​Request body

​Response

​Status codes

​Delete service

​Headers

​Path parameters

​Response

​Status codes

​Update credentials

​Headers

​Path parameters

​Request body

​Response

​Status codes

List services

Headers

Response

Status codes

Create service

Headers

Request body

Response

Status codes

Get service

Headers

Path parameters

Response

Status codes

Update service

Headers

Path parameters

Request body

Response

Status codes

Delete service

Headers

Path parameters

Response

Status codes

Update credentials

Headers

Path parameters

Request body

Response

Status codes