# ping

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /srv/v1/ping:
    post:
      summary: ping
      deprecated: false
      description: >-
        After a deployment or upgrade of a ROCKIT Edge instance it is
        recommended to verify that the endpoints can be reached. As simple test
        please invoke `POST /srv/v1/ping` which verifies


        - the proper API Gateway configuration

        - Fn / CWL configuration

        - OCI authentication

        - Database access
      tags:
        - ROCKIT Edge - Admin API/Installation / Upgrade
      parameters:
        - name: Content-Type
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
        - name: x-rockit-admin-token
          in: header
          description: ''
          required: false
          example: '{{EDGE_ADMIN_TOKEN}}'
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties: {}
            example: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Indicates that the ping request was successful.
                  message:
                    type: string
                    description: >-
                      Returns a confirmation message (typically "pong") to
                      signal that the API is reachable and operational.
                required:
                  - status
                  - message
                x-apidog-orders:
                  - status
                  - message
              example:
                status: success
                message: pong
          headers: {}
          x-apidog-name: Success
        '401':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: >-
                      Reflects that the request encountered an error due to
                      failed authentication.
                  error:
                    type: string
                    description: >-
                      Provides a concise error identifier (e.g., "Unauthorized")
                      that specifies the nature of the authentication failure.
                  message:
                    type: string
                    description: >-
                      Offers a detailed explanation indicating that the request
                      was rejected because the proper credentials or permissions
                      were not provided.
                required:
                  - status
                  - error
                  - message
                x-apidog-orders:
                  - status
                  - error
                  - message
              example:
                status: string
                error: string
                message: string
          headers: {}
          x-apidog-name: Unauthorized
      security: []
      x-apidog-folder: ROCKIT Edge - Admin API/Installation / Upgrade
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/732774/apis/api-11591046-run
components:
  schemas: {}
  securitySchemes:
    Bearer token:
      type: bearer
      scheme: bearer
      description: >-
        Enter your Access Token. You can obtain this by calling the /be/v1/login
        endpoint. Use the Refresh token to get a new Access token when it
        expires.
servers:
  - url: https://Example-Server.com
    description: Default
security: []

```