Skilljar Ping API

The Ping API from Skilljar — 1 operation(s) for ping.

OpenAPI Specification

skilljar-ping-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Skilljar Assets Ping API
  version: 1.0.0
  description: 'The Skilljar API provides comprehensive access to our customer education platform, enabling you to programmatically manage courses, users, enrollments, and more.


    This interactive documentation is automatically generated from our codebase and stays current with the latest features and endpoints.


    ## Getting Started


    New to the Skilljar API? Check out these essential resources:


    - **[API Getting Started Guide](https://support.gainsight.com/Skilljar/Develop_and_Customize/API/Getting_started_with_the_Skilljar_API)** - Authentication, basic concepts, and your first API call

    - **[Token-based SSO](https://support.gainsight.com/Skilljar/Develop_and_Customize/Single_Sign_on_(SSO)/Configuring_Token-Based_Single_Sign-On_(SSO))** - Seamlessly integrate user authentication

    - **[Webhooks](https://support.gainsight.com/Skilljar/Develop_and_Customize/API/Using_Webhooks_API)** - Real-time notifications for platform events

    '
tags:
- name: Ping
paths:
  /v1/ping:
    get:
      operationId: ping_retrieve
      description: Ping the API endpoint.  HTTP 2xx responses indicate a successful authentication with the Skilljar API endpoint.
      summary: Ping API
      tags:
      - Ping
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          description: No response body
components:
  securitySchemes:
    OrganizationApiKey:
      type: http
      scheme: basic
      description: API key authentication using HTTP Basic Auth. Use your API key as the username and leave password empty.
    tokenAuth:
      type: http
      scheme: bearer