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

# Let NX1 register itself with the host

> Try to register NX1 at the host's sign-in server, as the registry
does for MCP servers.

Where the host advertises a registration endpoint nobody pastes
anything. GitHub and Bitbucket create apps by hand, so this answers
`registered: false` and the client ID is asked for instead.



## OpenAPI

````yaml post /api/code-hosts/apps/{provider}/register
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/code-hosts/apps/{provider}/register:
    post:
      tags:
        - Code hosts
      summary: Let NX1 register itself with the host
      description: |-
        Try to register NX1 at the host's sign-in server, as the registry
        does for MCP servers.

        Where the host advertises a registration endpoint nobody pastes
        anything. GitHub and Bitbucket create apps by hand, so this answers
        `registered: false` and the client ID is asked for instead.
      operationId: dynamic_register_api_code_hosts_apps__provider__register_post
      parameters:
        - name: provider
          in: path
          required: true
          schema:
            type: string
            description: The code host's key.
            title: Provider
          description: The code host's key.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CodeHostAppRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: >-
                  Response Dynamic Register Api Code Hosts Apps  Provider 
                  Register Post
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Conflict
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unprocessable Content
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    CodeHostAppRequest:
      properties:
        client_id:
          type: string
          maxLength: 256
          title: Client Id
          default: ''
        client_secret:
          anyOf:
            - type: string
              maxLength: 512
            - type: 'null'
          title: Client Secret
          description: Write-only. Empty keeps the stored one.
        base_url:
          anyOf:
            - type: string
              maxLength: 512
            - type: 'null'
          title: Base Url
          description: A self-hosted host's base URL.
        directory:
          anyOf:
            - type: string
              maxLength: 128
            - type: 'null'
          title: Directory
          description: Azure DevOps' Entra directory.
      type: object
      title: CodeHostAppRequest
      description: Register a provider's OAuth app.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

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