Observability

Manage observability for your Kubernetes clusters.

List active alerts in organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "List active alerts in organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/alerts

Response

    No Content

                
{
  "items": {
    "$ref": "#/components/schemas/Alerts"
  },
  "type": "array"
}
                    

List active alerts in observability tenant.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "List active alerts in observability tenant."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/alerts/{tenantSlug}

Response

    No Content

                
{
  "items": {
    "$ref": "#/components/schemas/CortexTenantAlert"
  },
  "type": "array"
}
                    

Get AlertManager configuration of an environment.

Path Parameters:

  • organisationSlug
  • environmentSlug
HTTP Responses codes for "Get AlertManager configuration of an environment."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/environments/{environmentSlug}/prometheus/alertmanager

Response

  • alertManagerConfig string
  • ruleFiles object
  • templateFiles object
                
{
  "properties": {
    "alertManagerConfig": {
      "type": "string"
    },
    "ruleFiles": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "templateFiles": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    }
  },
  "type": "object"
}
                    

Replace AlertManager configuration of an environment.

Path Parameters:

  • organisationSlug
  • environmentSlug
HTTP Responses codes for "Replace AlertManager configuration of an environment."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • alertManagerConfig string
  • ruleFiles object
  • templateFiles object
POST /api/v1/orgs/{organisationSlug}/environments/{environmentSlug}/prometheus/alertmanager

Response

  • message string
                
{
  "properties": {
    "message": {
      "type": "string"
    }
  },
  "type": "object"
}
                    

Copy default prometheus rules to an environment.

Path Parameters:

  • organisationSlug
  • environmentSlug
HTTP Responses codes for "Copy default prometheus rules to an environment."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
POST /api/v1/orgs/{organisationSlug}/environments/{environmentSlug}/prometheus/alertmanager/default-rules

Response

  • message string
                
{
  "properties": {
    "message": {
      "type": "string"
    }
  },
  "type": "object"
}
                    

List existing Grafana integrations in an organisation.

Path Parameters:

  • organisationSlug

Query Parameters:

  • pageable (Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC)
HTTP Responses codes for "List existing Grafana integrations in an organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

GrafanaIntegrationResponse
  • createdAt date-time
  • customer string
  • datasourcePrefix string
  • deletedAt date-time
  • identity uuid
  • manageDatasources boolean
  • modifiedAt date-time
  • name string
  • provisionUsers boolean
  • slug string
  • status string
  • statusMessage string
  • url string
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort object
    One of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • empty boolean
  • sorted boolean
  • unsorted boolean
GET /api/v1/orgs/{organisationSlug}/integrations/grafana

Response

  • content array
    List of #/components/schemas/GrafanaIntegrationResponse
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort object
    One of #/components/schemas/SortObject
  • totalElements int64
  • totalPages int32
                
{
  "properties": {
    "content": {
      "items": {
        "$ref": "#/components/schemas/GrafanaIntegrationResponse"
      },
      "type": "array"
    },
    "empty": {
      "type": "boolean"
    },
    "first": {
      "type": "boolean"
    },
    "last": {
      "type": "boolean"
    },
    "number": {
      "format": "int32",
      "type": "integer"
    },
    "numberOfElements": {
      "format": "int32",
      "type": "integer"
    },
    "pageable": {
      "$ref": "#/components/schemas/PageableObject"
    },
    "size": {
      "format": "int32",
      "type": "integer"
    },
    "sort": {
      "$ref": "#/components/schemas/SortObject"
    },
    "totalElements": {
      "format": "int64",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object"
}
                    

Create a Grafana integrations in an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Create a Grafana integrations in an organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • apiToken string
  • datasourcePrefix string
  • name string
  • url string
POST /api/v1/orgs/{organisationSlug}/integrations/grafana

Response

  • createdAt date-time
  • customer string
  • datasourcePrefix string
  • deletedAt date-time
  • identity uuid
  • manageDatasources boolean
  • modifiedAt date-time
  • name string
  • provisionUsers boolean
  • slug string
  • status string
  • statusMessage string
  • url string
                
{
  "properties": {
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "customer": {
      "type": "string"
    },
    "datasourcePrefix": {
      "type": "string"
    },
    "deletedAt": {
      "format": "date-time",
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "manageDatasources": {
      "type": "boolean"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "provisionUsers": {
      "type": "boolean"
    },
    "slug": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "statusMessage": {
      "type": "string"
    },
    "url": {
      "type": "string"
    }
  },
  "type": "object"
}
                    

Delete a Grafana integration from an organisation.

Path Parameters:

  • organisationSlug
  • integrationSlug
HTTP Responses codes for "Delete a Grafana integration from an organisation."
Status CodeDescription
204Request was successfully processed, but there is no response body to return.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
DELETE /api/v1/orgs/{organisationSlug}/integrations/grafana/{integrationSlug}

Response

    No Content

                
                    

List observability tenants.

Path Parameters:

  • organisationSlug

Query Parameters:

  • page
  • pageable (Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC)
HTTP Responses codes for "List observability tenants."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

ObservabilityTenant
  • available boolean
  • cluster object
    One of #/components/schemas/ObservabilityTenantClusterRef
  • createdAt date-time
  • customer string
  • deletedAt date-time
  • environment object
    One of #/components/schemas/ObservabilityTenantEnvironmentRef
  • id int64
  • identity uuid
  • ipWhiteList string
  • modifiedAt date-time
  • name string
  • slug string
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort object
    One of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • empty boolean
  • sorted boolean
  • unsorted boolean
GET /api/v1/orgs/{organisationSlug}/monitoring

Response

  • content array
    List of #/components/schemas/ObservabilityTenant
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort object
    One of #/components/schemas/SortObject
  • totalElements int64
  • totalPages int32
                
{
  "properties": {
    "content": {
      "items": {
        "$ref": "#/components/schemas/ObservabilityTenant"
      },
      "type": "array"
    },
    "empty": {
      "type": "boolean"
    },
    "first": {
      "type": "boolean"
    },
    "last": {
      "type": "boolean"
    },
    "number": {
      "format": "int32",
      "type": "integer"
    },
    "numberOfElements": {
      "format": "int32",
      "type": "integer"
    },
    "pageable": {
      "$ref": "#/components/schemas/PageableObject"
    },
    "size": {
      "format": "int32",
      "type": "integer"
    },
    "sort": {
      "$ref": "#/components/schemas/SortObject"
    },
    "totalElements": {
      "format": "int64",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object"
}
                    

Count observability tenants.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Count observability tenants."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/monitoring/count

Response

  • count int64
                
{
  "properties": {
    "count": {
      "format": "int64",
      "type": "integer"
    }
  },
  "type": "object"
}
                    

Get observability tenant.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "Get observability tenant."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

ObservabilityTenantClusterRef
  • environmentSlug string
  • id int64
  • identity uuid
  • name string
  • slug string
  • version string
ObservabilityTenantEnvironmentRef
  • id int64
  • name string
  • slug string
GET /api/v1/orgs/{organisationSlug}/monitoring/{tenantSlug}

Response

  • available boolean
  • cluster object
    One of #/components/schemas/ObservabilityTenantClusterRef
  • createdAt date-time
  • customer string
  • deletedAt date-time
  • environment object
    One of #/components/schemas/ObservabilityTenantEnvironmentRef
  • id int64
  • identity uuid
  • ipWhiteList string
  • modifiedAt date-time
  • name string
  • slug string
                
{
  "properties": {
    "available": {
      "type": "boolean"
    },
    "cluster": {
      "$ref": "#/components/schemas/ObservabilityTenantClusterRef"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "customer": {
      "type": "string"
    },
    "deletedAt": {
      "format": "date-time",
      "type": "string"
    },
    "environment": {
      "$ref": "#/components/schemas/ObservabilityTenantEnvironmentRef"
    },
    "id": {
      "format": "int64",
      "type": "integer"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "ipWhiteList": {
      "type": "string"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    }
  },
  "type": "object"
}
                    

Get AlertManager observability tenant configuration.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "Get AlertManager observability tenant configuration."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/monitoring/{tenantSlug}/alertmanager

Response

  • alertManagerConfig string
  • ruleFiles object
  • templateFiles object
                
{
  "properties": {
    "alertManagerConfig": {
      "type": "string"
    },
    "ruleFiles": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "templateFiles": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    }
  },
  "type": "object"
}
                    

Replace AlertManager observability tenant configuration.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "Replace AlertManager observability tenant configuration."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • alertManagerConfig string
  • ruleFiles object
  • templateFiles object
POST /api/v1/orgs/{organisationSlug}/monitoring/{tenantSlug}/alertmanager

Response

  • message string
                
{
  "properties": {
    "message": {
      "type": "string"
    }
  },
  "type": "object"
}
                    

Validate AlertManager observability tenant configuration.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "Validate AlertManager observability tenant configuration."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • alertManagerConfig string
  • ruleFiles object
  • templateFiles object
POST /api/v1/orgs/{organisationSlug}/monitoring/{tenantSlug}/alertmanager/validate

Response

    No Content

                
{
  "type": "object"
}
                    

Get observability tenant stats.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "Get observability tenant stats."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/monitoring/{tenantSlug}/stats

Response

  • APIIngestionRate float
  • RuleIngestionRate float
  • ingestionRate float
  • numSeries float
                
{
  "properties": {
    "APIIngestionRate": {
      "format": "float",
      "type": "number"
    },
    "RuleIngestionRate": {
      "format": "float",
      "type": "number"
    },
    "ingestionRate": {
      "format": "float",
      "type": "number"
    },
    "numSeries": {
      "format": "float",
      "type": "number"
    }
  },
  "type": "object"
}
                    

List monitoring tenant tokens.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "List monitoring tenant tokens."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/monitoring/{tenantSlug}/tokens

Response

    No Content

                
{
  "items": {
    "$ref": "#/components/schemas/AccessToken"
  },
  "type": "array"
}
                    

Create new monitoring tenant token.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "Create new monitoring tenant token."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • displayName string
  • ipWhiteList string
  • scopes object
    One of #/components/schemas/CreateAccessTokenScopes

Related Objects

CreateAccessTokenScopes
  • alertManager boolean
  • loki boolean
  • lokiReadOnly boolean
  • prometheus boolean
  • prometheusReadOnly boolean
POST /api/v1/orgs/{organisationSlug}/monitoring/{tenantSlug}/tokens

Response

  • createdAt date-time
  • displayName string
  • id int64
  • ipWhiteList string
  • lastUsedAt date-time
  • token string
                
{
  "properties": {
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "id": {
      "format": "int64",
      "type": "integer"
    },
    "ipWhiteList": {
      "type": "string"
    },
    "lastUsedAt": {
      "format": "date-time",
      "type": "string"
    },
    "token": {
      "type": "string"
    }
  },
  "type": "object"
}
                    

Revoke an access token from an observability tenant.

Path Parameters:

  • organisationSlug
  • tenantSlug
  • tokenID
HTTP Responses codes for "Revoke an access token from an observability tenant."
Status CodeDescription
204Request was successfully processed, but there is no response body to return.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
DELETE /api/v1/orgs/{organisationSlug}/monitoring/{tenantSlug}/tokens/{tokenID}

Response

    No Content

                
                    

List observability tenants.

Path Parameters:

  • organisationSlug

Query Parameters:

  • page
  • pageable (Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC)
HTTP Responses codes for "List observability tenants."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

ObservabilityTenant
  • available boolean
  • cluster object
    One of #/components/schemas/ObservabilityTenantClusterRef
  • createdAt date-time
  • customer string
  • deletedAt date-time
  • environment object
    One of #/components/schemas/ObservabilityTenantEnvironmentRef
  • id int64
  • identity uuid
  • ipWhiteList string
  • modifiedAt date-time
  • name string
  • slug string
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort object
    One of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • empty boolean
  • sorted boolean
  • unsorted boolean
GET /api/v1/orgs/{organisationSlug}/observability

Response

  • content array
    List of #/components/schemas/ObservabilityTenant
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort object
    One of #/components/schemas/SortObject
  • totalElements int64
  • totalPages int32
                
{
  "properties": {
    "content": {
      "items": {
        "$ref": "#/components/schemas/ObservabilityTenant"
      },
      "type": "array"
    },
    "empty": {
      "type": "boolean"
    },
    "first": {
      "type": "boolean"
    },
    "last": {
      "type": "boolean"
    },
    "number": {
      "format": "int32",
      "type": "integer"
    },
    "numberOfElements": {
      "format": "int32",
      "type": "integer"
    },
    "pageable": {
      "$ref": "#/components/schemas/PageableObject"
    },
    "size": {
      "format": "int32",
      "type": "integer"
    },
    "sort": {
      "$ref": "#/components/schemas/SortObject"
    },
    "totalElements": {
      "format": "int64",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object"
}
                    

Count observability tenants.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Count observability tenants."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/observability/count

Response

  • count int64
                
{
  "properties": {
    "count": {
      "format": "int64",
      "type": "integer"
    }
  },
  "type": "object"
}
                    

Get observability tenant.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "Get observability tenant."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

ObservabilityTenantClusterRef
  • environmentSlug string
  • id int64
  • identity uuid
  • name string
  • slug string
  • version string
ObservabilityTenantEnvironmentRef
  • id int64
  • name string
  • slug string
GET /api/v1/orgs/{organisationSlug}/observability/{tenantSlug}

Response

  • available boolean
  • cluster object
    One of #/components/schemas/ObservabilityTenantClusterRef
  • createdAt date-time
  • customer string
  • deletedAt date-time
  • environment object
    One of #/components/schemas/ObservabilityTenantEnvironmentRef
  • id int64
  • identity uuid
  • ipWhiteList string
  • modifiedAt date-time
  • name string
  • slug string
                
{
  "properties": {
    "available": {
      "type": "boolean"
    },
    "cluster": {
      "$ref": "#/components/schemas/ObservabilityTenantClusterRef"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "customer": {
      "type": "string"
    },
    "deletedAt": {
      "format": "date-time",
      "type": "string"
    },
    "environment": {
      "$ref": "#/components/schemas/ObservabilityTenantEnvironmentRef"
    },
    "id": {
      "format": "int64",
      "type": "integer"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "ipWhiteList": {
      "type": "string"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    }
  },
  "type": "object"
}
                    

Get AlertManager observability tenant configuration.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "Get AlertManager observability tenant configuration."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/observability/{tenantSlug}/alertmanager

Response

  • alertManagerConfig string
  • ruleFiles object
  • templateFiles object
                
{
  "properties": {
    "alertManagerConfig": {
      "type": "string"
    },
    "ruleFiles": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "templateFiles": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    }
  },
  "type": "object"
}
                    

Replace AlertManager observability tenant configuration.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "Replace AlertManager observability tenant configuration."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • alertManagerConfig string
  • ruleFiles object
  • templateFiles object
POST /api/v1/orgs/{organisationSlug}/observability/{tenantSlug}/alertmanager

Response

  • message string
                
{
  "properties": {
    "message": {
      "type": "string"
    }
  },
  "type": "object"
}
                    

Validate AlertManager observability tenant configuration.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "Validate AlertManager observability tenant configuration."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • alertManagerConfig string
  • ruleFiles object
  • templateFiles object
POST /api/v1/orgs/{organisationSlug}/observability/{tenantSlug}/alertmanager/validate

Response

    No Content

                
{
  "type": "object"
}
                    

List silences for observability tenant.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "List silences for observability tenant."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/observability/{tenantSlug}/silences

Response

    No Content

                
{
  "items": {
    "$ref": "#/components/schemas/CortexAlertmanagerSilence"
  },
  "type": "array"
}
                    

Create or update silence for observability tenant.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "Create or update silence for observability tenant."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • comment string
  • createdBy string
  • endsAt string
  • id string
  • matchers array
    List of #/components/schemas/SilenceMatcher
  • startsAt string
  • status object
    One of #/components/schemas/SilenceStatus

Related Objects

SilenceMatcher
  • isEqual boolean
  • isRegex boolean
  • name string
  • value string
SilenceStatus
  • state string
POST /api/v1/orgs/{organisationSlug}/observability/{tenantSlug}/silences

Response

  • comment string
  • createdBy string
  • endsAt string
  • id string
  • matchers array
    List of #/components/schemas/SilenceMatcher
  • startsAt string
  • status object
    One of #/components/schemas/SilenceStatus
                
{
  "properties": {
    "comment": {
      "type": "string"
    },
    "createdBy": {
      "type": "string"
    },
    "endsAt": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "matchers": {
      "items": {
        "$ref": "#/components/schemas/SilenceMatcher"
      },
      "type": "array"
    },
    "startsAt": {
      "type": "string"
    },
    "status": {
      "$ref": "#/components/schemas/SilenceStatus"
    }
  },
  "type": "object"
}
                    

Delete silence for observability tenant.

Path Parameters:

  • organisationSlug
  • tenantSlug
  • silenceID
HTTP Responses codes for "Delete silence for observability tenant."
Status CodeDescription
204Request was successfully processed, but there is no response body to return.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
DELETE /api/v1/orgs/{organisationSlug}/observability/{tenantSlug}/silences/{silenceID}

Response

    No Content

                
                    

Get observability tenant stats.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "Get observability tenant stats."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/observability/{tenantSlug}/stats

Response

  • APIIngestionRate float
  • RuleIngestionRate float
  • ingestionRate float
  • numSeries float
                
{
  "properties": {
    "APIIngestionRate": {
      "format": "float",
      "type": "number"
    },
    "RuleIngestionRate": {
      "format": "float",
      "type": "number"
    },
    "ingestionRate": {
      "format": "float",
      "type": "number"
    },
    "numSeries": {
      "format": "float",
      "type": "number"
    }
  },
  "type": "object"
}
                    

List monitoring tenant tokens.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "List monitoring tenant tokens."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/observability/{tenantSlug}/tokens

Response

    No Content

                
{
  "items": {
    "$ref": "#/components/schemas/AccessToken"
  },
  "type": "array"
}
                    

Create new monitoring tenant token.

Path Parameters:

  • organisationSlug
  • tenantSlug
HTTP Responses codes for "Create new monitoring tenant token."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • displayName string
  • ipWhiteList string
  • scopes object
    One of #/components/schemas/CreateAccessTokenScopes

Related Objects

CreateAccessTokenScopes
  • alertManager boolean
  • loki boolean
  • lokiReadOnly boolean
  • prometheus boolean
  • prometheusReadOnly boolean
POST /api/v1/orgs/{organisationSlug}/observability/{tenantSlug}/tokens

Response

  • createdAt date-time
  • displayName string
  • id int64
  • ipWhiteList string
  • lastUsedAt date-time
  • token string
                
{
  "properties": {
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "id": {
      "format": "int64",
      "type": "integer"
    },
    "ipWhiteList": {
      "type": "string"
    },
    "lastUsedAt": {
      "format": "date-time",
      "type": "string"
    },
    "token": {
      "type": "string"
    }
  },
  "type": "object"
}
                    

Revoke an access token from an observability tenant.

Path Parameters:

  • organisationSlug
  • tenantSlug
  • tokenID
HTTP Responses codes for "Revoke an access token from an observability tenant."
Status CodeDescription
204Request was successfully processed, but there is no response body to return.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
DELETE /api/v1/orgs/{organisationSlug}/observability/{tenantSlug}/tokens/{tokenID}

Response

    No Content

                
                    

Query observability for cluster.

Path Parameters:

  • organisationSlug
  • clusterIdentity

Query Parameters:

  • query
  • start
  • end
  • step
  • timeout
HTTP Responses codes for "Query observability for cluster."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/query/cluster/{clusterIdentity}/query_range

Response

    No Content

                
{
  "items": {
    "format": "byte",
    "type": "string"
  },
  "type": "array"
}
                    

Query observability for organisation.

Path Parameters:

  • organisationSlug
  • tenantSlug

Query Parameters:

  • query
  • start
  • end
  • step
  • timeout
HTTP Responses codes for "Query observability for organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/query/{tenantSlug}/query_range

Response

    No Content

                
{
  "items": {
    "format": "byte",
    "type": "string"
  },
  "type": "array"
}