swagger: '2.0'
info:
  version: v1
  title: Connectors APIs
host: 'api.cloud.com'
schemes:
  - https
basePath: /connectors
paths:
  "/":
    get:
      tags:
        - Connectors
      summary: Get all Edge Servers (Connectors) for a customer.
      operationId: Connectors_GetAll
      consumes: []
      produces:
        - application/json
        - text/json
      parameters:
        - name: Authorization
          in: header
          description: The access token.
          required: true
          type: string
        - name: Citrix-CustomerId
          in: header
          description: ID of the customer.
          required: true
          type: string
        - name: Location
          in: query
          schema:
            maxLength: 256
            minLength: 0
            type: string
        - name: ExtendedData
          in: query
          schema:
            type: boolean
        - name: ConnectorType
          in: query
          schema:
            maxLength: 256
            minLength: 0
            type: string
        - name: RetrieveExpectedVersion
          in: query
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Citrix.CloudServices.AgentHub.Api.EdgeServersGetResultModel'
  "/{Id}":
    delete:
      tags:
        - Connectors
      summary: Delete a connector.
      operationId: Connectors_Delete
      consumes: []
      produces: []
      parameters:
        - name: Authorization
          in: header
          description: The access token.
          required: true
          type: string        
        - name: Citrix-CustomerId
          in: header
          description: ID of the customer.
          required: true
          type: string
        - name: Id
          in: path
          description: The connector id.
          required: true
          type: string
      responses:
        '200':
          description: OK
          schema:
            type: boolean
definitions:
  Citrix.CloudServices.AgentHub.Api.EdgeServersGetResultModel:
    type: object
    properties:
      id:
        type: string
      fqdn:
        type: string
      role:
        type: string
      windowsSid:
        type: string
      location:
        type: string
      currentVersion:
        type: string
      currentBootstrapperVersion:
        type: string
      expectedVersion:
        type: string
      expectedBootStrapperVersion:
        type: string
      versionState:
        type: string
      inMaintenance:
        type: boolean
      leaseEndDateTime:
        format: date-time
        type: string
      upgradeDisabled:
        type: boolean
      connectorType:
        enum:
          - 0
          - 1
          - 2147483647
        type: integer
      status:
        type: string
      lastContactDate:
        format: date-time
        type: string
securityDefinitions:
  CWSAuth:
    type: apiKey
    name: Authorization
    in: header
  Basic:
    type: basic
security:
  - CWSAuth: []
  - Basic: []
tags:
  - name: Connectors
    description: Requests for Connectors.