openapi: 3.0.2 info: contact: name: IXON B.V. url: https://www.ixon.cloud/ email: support@ixon.cloud description: API for the IXON Cloud Platform license: name: All Rights Reserved url: https://www.ixon.cloud/ title: IXON AccessRecoverList LicenceList API version: 0.1.294 servers: - description: IXON Cloud platform server url: https://portal.ixon.cloud:443/api/ tags: - name: LicenceList paths: /licences: get: tags: - LicenceList summary: LicenceList responses: '200': description: Success response. Data could be an object instead of a list when one value is returned content: application/json: schema: type: object required: - status - type - data properties: status: type: string default: success nullable: false type: type: string nullable: false moreAfter: type: string nullable: true data: nullable: false type: array items: type: object properties: publicId: maxLength: 12 minLength: 12 nullable: false type: string type: nullable: false type: object properties: publicId: maxLength: 12 minLength: 12 nullable: false type: string usageType: enum: - advanced-user-management - agent-registration-profile - agent-templates - alarming - api-integrations - app-engine-level-1 - app-engine-level-2 - app-engine-level-3 - asset-management - card-view - connection-monitoring - controlled-devices - custom-branding - custom-domain - custom-fields - custom-legal - custom-legal-legacy - custom-sso - edge-app-management - ixagent - landing-page - live-data - logging - m2m-cloud-cluster - main-pages - mobile-app - mqtt-device - object-storage - premium-branding - rdp - remote-access - reporting - request-access - rtsp - scim - session-recording - sla - ssh - subgroups - temporary-access - vpn-access-rule - vpn-usage nullable: false type: string companyLimit: maximum: 4294967295 nullable: true type: integer format: int32 scope: enum: - agent - company nullable: false type: string serialNumber: maxLength: 255 minLength: 1 nullable: false type: string expiresOn: nullable: true type: string format: date-time activated: nullable: false type: boolean trial: nullable: false type: boolean value: maxLength: 255 minLength: 1 nullable: true type: string locked: nullable: true type: boolean maxRetentionPolicy: maxLength: 255 minLength: 2 nullable: true type: string agent: nullable: true type: object properties: publicId: maxLength: 12 minLength: 12 nullable: false type: string name: maxLength: 255 minLength: 0 nullable: true type: string deviceId: maxLength: 128 minLength: 1 nullable: false type: string type: nullable: false type: object properties: publicId: nullable: false type: string location: nullable: false type: object properties: name: maxLength: 255 minLength: 1 nullable: false type: string latitude: nullable: false type: string longitude: nullable: false type: string geoLocation: nullable: false type: object properties: latitude: nullable: false type: string longitude: nullable: false type: string country: maxLength: 255 minLength: 1 nullable: false type: string city: maxLength: 255 minLength: 1 nullable: false type: string custom: nullable: false type: object hasAgent: nullable: false type: boolean agentType: nullable: true type: object properties: publicId: maxLength: 12 minLength: 12 nullable: false type: string additionalSubnets: nullable: false type: boolean allowDataPublishing: nullable: false type: boolean allowDemoDevice: nullable: false type: boolean allowTemplating: nullable: false type: boolean allowReboot: nullable: false type: boolean configPush: nullable: false type: boolean configFileFormat: maximum: 4294967295 nullable: false type: integer format: int32 customServers: nullable: false type: boolean deviceIdFormat: maxLength: 255 minLength: 1 nullable: false type: string httpProxyPort: maximum: 65535 nullable: true type: integer format: int32 latestFirmwareFile: nullable: false type: object properties: publicId: maxLength: 12 minLength: 12 nullable: false type: string name: maxLength: 255 minLength: 1 nullable: false type: string description: maxLength: 65535 minLength: 0 nullable: false type: string code: maxLength: 255 minLength: 1 nullable: false type: string notes: maxLength: 65535 minLength: 0 nullable: false type: string agentType: nullable: false type: object properties: publicId: nullable: false type: string type: enum: - firmware nullable: false type: string latest: nullable: false type: boolean custom: nullable: false type: object name: maxLength: 255 minLength: 1 nullable: false type: string offlineConfiguration: nullable: false type: boolean openvpnConfigMultiUse: nullable: false type: boolean purchasePrice: nullable: false type: object properties: gratis: nullable: false type: boolean router: nullable: false type: boolean stunnelSupport: nullable: false type: boolean wanPortForwardings: nullable: false type: boolean custom: nullable: false type: object hasSecondWanPort: nullable: false type: boolean bundle: nullable: true type: object properties: publicId: maxLength: 12 minLength: 12 nullable: false type: string name: maxLength: 255 minLength: 1 nullable: false type: string 4XX: $ref: '#/components/responses/4XXErrorResponse' parameters: - $ref: '#/components/parameters/apiVersion' - $ref: '#/components/parameters/apiApplication' - $ref: '#/components/parameters/apiCompany' - $ref: '#/components/parameters/apiBrandingOptional' - $ref: '#/components/parameters/fieldsParameter' - $ref: '#/components/parameters/filtersParameter' security: - bearerToken: [] post: tags: - LicenceList summary: LicenceList responses: '201': description: Success response. Data could be an object instead of a list when one value is returned content: application/json: schema: type: object required: - status - type - data properties: status: type: string default: success nullable: false type: type: string nullable: false moreAfter: type: string nullable: true data: nullable: false type: array items: type: object properties: publicId: maxLength: 12 minLength: 12 nullable: false type: string type: nullable: false type: object properties: publicId: maxLength: 12 minLength: 12 nullable: false type: string usageType: enum: - advanced-user-management - agent-registration-profile - agent-templates - alarming - api-integrations - app-engine-level-1 - app-engine-level-2 - app-engine-level-3 - asset-management - card-view - connection-monitoring - controlled-devices - custom-branding - custom-domain - custom-fields - custom-legal - custom-legal-legacy - custom-sso - edge-app-management - ixagent - landing-page - live-data - logging - m2m-cloud-cluster - main-pages - mobile-app - mqtt-device - object-storage - premium-branding - rdp - remote-access - reporting - request-access - rtsp - scim - session-recording - sla - ssh - subgroups - temporary-access - vpn-access-rule - vpn-usage nullable: false type: string companyLimit: maximum: 4294967295 nullable: true type: integer format: int32 scope: enum: - agent - company nullable: false type: string serialNumber: maxLength: 255 minLength: 1 nullable: false type: string expiresOn: nullable: true type: string format: date-time activated: nullable: false type: boolean trial: nullable: false type: boolean value: maxLength: 255 minLength: 1 nullable: true type: string locked: nullable: true type: boolean maxRetentionPolicy: maxLength: 255 minLength: 2 nullable: true type: string agent: nullable: true type: object properties: publicId: maxLength: 12 minLength: 12 nullable: false type: string name: maxLength: 255 minLength: 0 nullable: true type: string deviceId: maxLength: 128 minLength: 1 nullable: false type: string type: nullable: false type: object properties: publicId: nullable: false type: string location: nullable: false type: object properties: name: maxLength: 255 minLength: 1 nullable: false type: string latitude: nullable: false type: string longitude: nullable: false type: string geoLocation: nullable: false type: object properties: latitude: nullable: false type: string longitude: nullable: false type: string country: maxLength: 255 minLength: 1 nullable: false type: string city: maxLength: 255 minLength: 1 nullable: false type: string custom: nullable: false type: object hasAgent: nullable: false type: boolean agentType: nullable: true type: object properties: publicId: maxLength: 12 minLength: 12 nullable: false type: string additionalSubnets: nullable: false type: boolean allowDataPublishing: nullable: false type: boolean allowDemoDevice: nullable: false type: boolean allowTemplating: nullable: false type: boolean allowReboot: nullable: false type: boolean configPush: nullable: false type: boolean configFileFormat: maximum: 4294967295 nullable: false type: integer format: int32 customServers: nullable: false type: boolean deviceIdFormat: maxLength: 255 minLength: 1 nullable: false type: string httpProxyPort: maximum: 65535 nullable: true type: integer format: int32 latestFirmwareFile: nullable: false type: object properties: publicId: maxLength: 12 minLength: 12 nullable: false type: string name: maxLength: 255 minLength: 1 nullable: false type: string description: maxLength: 65535 minLength: 0 nullable: false type: string code: maxLength: 255 minLength: 1 nullable: false type: string notes: maxLength: 65535 minLength: 0 nullable: false type: string agentType: nullable: false type: object properties: publicId: nullable: false type: string type: enum: - firmware nullable: false type: string latest: nullable: false type: boolean custom: nullable: false type: object name: maxLength: 255 minLength: 1 nullable: false type: string offlineConfiguration: nullable: false type: boolean openvpnConfigMultiUse: nullable: false type: boolean purchasePrice: nullable: false type: object properties: gratis: nullable: false type: boolean router: nullable: false type: boolean stunnelSupport: nullable: false type: boolean wanPortForwardings: nullable: false type: boolean custom: nullable: false type: object hasSecondWanPort: nullable: false type: boolean bundle: nullable: true type: object properties: publicId: maxLength: 12 minLength: 12 nullable: false type: string name: maxLength: 255 minLength: 1 nullable: false type: string 4XX: $ref: '#/components/responses/4XXErrorResponse' parameters: - $ref: '#/components/parameters/apiVersion' - $ref: '#/components/parameters/apiApplication' - $ref: '#/components/parameters/apiCompany' - $ref: '#/components/parameters/apiBrandingOptional' requestBody: required: true content: application/json: schema: type: array items: type: object properties: couponCode: maxLength: 15 minLength: 15 nullable: false pattern: ([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})(-([1-9]{3}|[B-DF-HJ-NP-TV-Z]{3})){3} type: string required: - couponCode description: You can give one item or a list of items security: - bearerToken: [] components: parameters: apiApplication: required: true description: Get your Application ID via support@ixon.cloud name: Api-Application in: header schema: type: string pattern: ^[0-9a-zA-Z]{12}$ apiVersion: required: true description: Version of the API to use name: Api-Version in: header schema: type: integer format: int32 enum: - 2 apiBrandingOptional: required: false description: Domain that provides the branding name: Api-Branding in: header schema: type: string pattern: .+(\..[^.]+) fieldsParameter: required: false description: 'Fields to select. Use "*" for all the top-level fields. Or check the "Success response" below for other fields. To get the fields of a subresource do subresource.field or for multiple fields of one subresource do subresource(field,field)' name: fields in: query schema: type: array items: type: string filtersParameter: required: false description: 'Filter the returned item(s). Format: operator(column,val) Possible operators are: lt, less, lte, lessorequal, eq, equals, ne, differs, gt, greater, gte, greaterorequal, in, ni, isnull, isnotnull, between, contains. Example: eq(publicId,"publicId_val")' name: filters in: query schema: type: array items: type: string apiCompany: required: true description: PublicId of the company name: Api-Company in: header schema: type: string pattern: ^(\d{4}-){4}\d{4}$ responses: 4XXErrorResponse: description: 4XX error response content: application/json: schema: type: object required: - status - type - data properties: status: type: string default: error nullable: false type: type: string default: Error nullable: false data: nullable: false type: array items: $ref: '#/components/schemas/4XXErrorSchema' schemas: 4XXErrorSchema: type: object properties: message: nullable: false type: string propertyName: nullable: true type: string listIndex: nullable: true type: integer format: int32 required: - message securitySchemes: bearerToken: type: http description: Bearer token created by the endpoint "POST AccessTokenList" scheme: bearer x-samples-languages: - curl - ruby - javascript - python - powershell