> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superlog.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a synthetic check

> Returns a synthetic check. Secret header values are not returned.



## OpenAPI

````yaml /api-reference/openapi.json get /synthetic-checks/{checkId}
openapi: 3.1.0
info:
  description: >-
    Manage a Superlog workspace's automations, runs, tag mode, model access, and
    secrets, read its telemetry, build dashboards and alerts over it, run
    synthetic checks, and export them to Terraform. Every request acts as the
    member who created the API key.
  title: Superlog management API
  version: 1.0.0
servers:
  - url: https://superlog.sh/api/v1
security:
  - bearerAuth: []
tags:
  - description: Connected integrations and the IDs automations and tag mode use.
    name: Integrations
  - description: The workspace and its members.
    name: Workspace
  - description: Keys that authenticate the management API and MCP server.
    name: API keys
  - description: Create and change automations.
    name: Automations
  - description: Start, follow, and cancel automation runs.
    name: Runs
  - description: What Superlog can use and change when someone mentions it in Slack.
    name: Tag mode
  - description: Model API keys, subscriptions, and available models.
    name: Models
  - description: Credentials agents can use without seeing them.
    name: Secrets
  - description: Read the workspace's logs, traces, and metrics.
    name: Telemetry
  - description: >-
      Exceptions in the workspace's telemetry, grouped into issues by
      fingerprint.
    name: Errors
  - description: Create and change dashboards over the workspace's telemetry.
    name: Dashboards
  - description: Threshold alerts on the workspace's telemetry that post to Slack.
    name: Alerts
  - description: HTTP checks that request a URL on a schedule and post failures to Slack.
    name: Synthetics
  - description: Configuration for the superloglabs/superlog Terraform provider.
    name: Terraform
paths:
  /synthetic-checks/{checkId}:
    get:
      tags:
        - Synthetics
      summary: Get a synthetic check
      description: Returns a synthetic check. Secret header values are not returned.
      operationId: get_synthetic_check
      parameters:
        - description: Synthetic check ID.
          in: path
          name: checkId
          required: true
          schema:
            type: string
            format: uuid
            description: Synthetic check ID.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  check:
                    type: object
                    properties:
                      assertions:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            kind:
                              type: string
                              enum:
                                - status_code
                                - response_time
                                - header
                                - body
                                - json_path
                                - certificate_expiry
                            op:
                              type: string
                              enum:
                                - eq
                                - neq
                                - lt
                                - gt
                                - contains
                                - not_contains
                                - exists
                                - not_exists
                            severity:
                              type: string
                              enum:
                                - critical
                                - degraded
                            value:
                              type: string
                          required:
                            - kind
                            - op
                            - severity
                            - value
                          additionalProperties: false
                      body:
                        anyOf:
                          - type: string
                          - type: 'null'
                      createdAt:
                        type: string
                      enabled:
                        type: boolean
                      failuresToAlert:
                        type: integer
                      followRedirects:
                        type: boolean
                      headers:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                            secret:
                              type: boolean
                            value:
                              type: string
                          required:
                            - name
                            - secret
                            - value
                          additionalProperties: false
                        description: A secret header's value is always empty.
                      id:
                        type: string
                        format: uuid
                        description: Synthetic check ID.
                      intervalSeconds:
                        type: integer
                      lastRunAt:
                        anyOf:
                          - type: string
                          - type: 'null'
                      lastStatus:
                        anyOf:
                          - type: string
                            enum:
                              - passed
                              - degraded
                              - failed
                          - type: 'null'
                      method:
                        type: string
                        enum:
                          - GET
                          - HEAD
                          - POST
                          - PUT
                          - PATCH
                          - DELETE
                          - OPTIONS
                      name:
                        type: string
                      retries:
                        type: integer
                      slack:
                        anyOf:
                          - type: object
                            properties:
                              channelId:
                                type: string
                              integrationAccountId:
                                type: string
                            required:
                              - channelId
                              - integrationAccountId
                            additionalProperties: false
                          - type: 'null'
                      statusSince:
                        anyOf:
                          - type: string
                          - type: 'null'
                        description: When the check reached its last status.
                      timeoutMs:
                        type: integer
                      updatedAt:
                        type: string
                      url:
                        type: string
                      webUrl:
                        type: string
                        format: uri
                        description: The check in Superlog.
                    required:
                      - assertions
                      - body
                      - createdAt
                      - enabled
                      - failuresToAlert
                      - followRedirects
                      - headers
                      - id
                      - intervalSeconds
                      - lastRunAt
                      - lastStatus
                      - method
                      - name
                      - retries
                      - slack
                      - statusSince
                      - timeoutMs
                      - updatedAt
                      - url
                      - webUrl
                    additionalProperties: false
                required:
                  - check
                additionalProperties: false
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The request is invalid. `issues` lists each invalid field.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: The API key is missing, revoked, or its creator left the workspace.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            The resource does not exist in this workspace, or the feature it
            belongs to is not enabled.
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          description: A stable machine-readable error code, when there is one.
          type: string
        error:
          type: string
          description: What went wrong.
        issues:
          description: Validation problems, one per invalid field.
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
            required:
              - message
              - path
            additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      description: A workspace API key, created in Superlog under Settings → API keys.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.