NInixopus
GitHub Connector

Create GitHub connector

Changed on

Create GitHub connector.

Auth: Required (bearer token). Scope: Organization-scoped in authenticated context. Side effects: May mutate server state.

post/api/v1/github-connector

Request

  • Base URL
    http://:8080
  • URL
    http://:8080/api/v1/github-connector
  • Auth
    none declared

Headers

Acceptstring

Request body */*

app_idstring uuid

GitHub App ID. Required if providing custom app credentials

client_idstring uuid

GitHub App OAuth client ID

client_secretstring

GitHub App OAuth client secret

installation_idstring uuid nullable

GitHub App installation ID

pemstring

GitHub App private key in PEM format

slugstring

GitHub App slug

webhook_secretstring

GitHub App webhook secret

Example request

{
  "app_id": "123456",
  "client_id": "Iv1.abc123def456",
  "installation_id": "12345678",
  "slug": "my-github-app"
}

Response

Created

messagestring
statusstring

Changes

  • 09f18af670c4Revision changes
    • breaking

      removed the success response with the status

    • info

      api tag GitHub Connector added

    • info

      api tag api/v1/github-connector removed

    • info

      added the success response with the status

  • 2beb810c5221Revision changes
    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/xml)

    • info

      api operation id createEndpoint2 removed and replaced with createGitHubConnector

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/xml)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)

    • info

      added the required property to the response with the status (media type: application/json)

    • info

      added the required property to the response with the status (media type: application/xml)