openapi: 3.2.0 info: title: Platform Credentials API version: 1.31.0 description: User API for accessing platform data servers: - url: https://api.losant.com security: - bearerAuth: [] tags: - name: Credentials paths: /applications/{applicationId}/credentials: get: operationId: credentials.get summary: Returns a collection of credentials for an application tags: - Credentials parameters: - name: applicationId in: path required: true description: ID associated with the application schema: type: string pattern: ^[A-Fa-f\d]{24}$ example: 575ec8687ae143cd83dc4a97 - name: sortField in: query required: false description: Field to sort the results by schema: type: string enum: - name - type - creationDate - lastUpdated default: creationDate example: creationDate - name: sortDirection in: query required: false description: Direction to sort the results by schema: type: string enum: - asc - desc default: desc example: asc - name: page in: query required: false description: Which page of results to return schema: type: string default: 0 example: 0 - name: perPage in: query required: false description: How many items to return per page schema: type: string default: 100 example: 10 - name: filterField in: query required: false description: Field to filter the results by. Blank or not provided means no filtering. schema: type: string enum: - name - type example: type - name: filter in: query required: false description: Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. schema: type: string example: aws responses: '200': description: Collection of credentials content: application/json: schema: $ref: '#/components/schemas/credentials' '400': description: Error if malformed request content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Error if application was not found content: application/json: schema: $ref: '#/components/schemas/error' x-losant-auth-scopes: - credentials.get post: operationId: credentials.post summary: Create a new credential for an application tags: - Credentials parameters: - name: applicationId in: path required: true description: ID associated with the application schema: type: string pattern: ^[A-Fa-f\d]{24}$ example: 575ec8687ae143cd83dc4a97 responses: '201': description: Successfully created credential content: application/json: schema: $ref: '#/components/schemas/credential' '400': description: Error if malformed request content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Error if application was not found content: application/json: schema: $ref: '#/components/schemas/error' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/credentialPost' description: Credential information x-losant-auth-scopes: - credentials.post /applications/{applicationId}/credentials/{credentialId}: get: operationId: credential.get summary: Retrieves information on a credential tags: - Credentials parameters: - name: applicationId in: path required: true description: ID associated with the application schema: type: string pattern: ^[A-Fa-f\d]{24}$ example: 575ec8687ae143cd83dc4a97 - name: credentialId in: path required: true description: ID associated with the credential schema: type: string pattern: ^[A-Fa-f\d]{24}$ example: 575ec76c7ae143cd83dc4a96 responses: '200': description: credential information content: application/json: schema: $ref: '#/components/schemas/credential' '400': description: Error if malformed request content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Error if credential was not found content: application/json: schema: $ref: '#/components/schemas/error' x-losant-auth-scopes: - credential.get patch: operationId: credential.patch summary: Updates information about a credential tags: - Credentials parameters: - name: applicationId in: path required: true description: ID associated with the application schema: type: string pattern: ^[A-Fa-f\d]{24}$ example: 575ec8687ae143cd83dc4a97 - name: credentialId in: path required: true description: ID associated with the credential schema: type: string pattern: ^[A-Fa-f\d]{24}$ example: 575ec76c7ae143cd83dc4a96 responses: '200': description: Updated credential information content: application/json: schema: $ref: '#/components/schemas/credential' '400': description: Error if malformed request content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Error if credential was not found content: application/json: schema: $ref: '#/components/schemas/error' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/credentialPatch' description: Object containing new properties of the credential x-losant-auth-scopes: - credential.patch delete: operationId: credential.delete summary: Deletes a credential tags: - Credentials parameters: - name: applicationId in: path required: true description: ID associated with the application schema: type: string pattern: ^[A-Fa-f\d]{24}$ example: 575ec8687ae143cd83dc4a97 - name: credentialId in: path required: true description: ID associated with the credential schema: type: string pattern: ^[A-Fa-f\d]{24}$ example: 575ec76c7ae143cd83dc4a96 responses: '200': description: If credential was successfully deleted content: application/json: schema: $ref: '#/components/schemas/success' '400': description: Error if malformed request content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Error if credential was not found content: application/json: schema: $ref: '#/components/schemas/error' x-losant-auth-scopes: - credential.delete /applications/{applicationId}/credentials/{credentialId}/linkedResources: get: operationId: credential.linkedResources summary: Retrieves information on resources linked to a credential tags: - Credentials parameters: - name: applicationId in: path required: true description: ID associated with the application schema: type: string pattern: ^[A-Fa-f\d]{24}$ example: 575ec8687ae143cd83dc4a97 - name: credentialId in: path required: true description: ID associated with the credential schema: type: string pattern: ^[A-Fa-f\d]{24}$ example: 575ec76c7ae143cd83dc4a96 - name: includeCustomNodes in: query required: false description: If the result of the request should also include the details of any custom nodes referenced by returned workflows schema: type: string default: false example: true responses: '200': description: Linked resource information content: application/json: schema: $ref: '#/components/schemas/credentialLinkedResources' '400': description: Error if malformed request content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Error if credential was not found content: application/json: schema: $ref: '#/components/schemas/error' x-losant-auth-scopes: - credential.linkedResources components: schemas: flowVersions: title: Workflow Versions description: Schema for a collection of Workflow Versions type: object properties: items: type: array items: $ref: '#/components/schemas/flowVersion' count: type: integer totalCount: type: integer perPage: type: integer page: type: integer filter: type: string filterField: type: string sortField: type: string sortDirection: type: string enum: - asc - desc - ASC - DESC - '' applicationId: type: string pattern: ^[A-Fa-f\d]{24}$ flowId: type: string pattern: ^[A-Fa-f\d]{24}$ version: type: string minLength: 1 maxLength: 255 flowClass: type: string enum: - cloud - edge - embedded - experience - customNode customNodes: type: array items: $ref: '#/components/schemas/flow' customNodeVersions: type: array items: $ref: '#/components/schemas/flowVersion' error: title: Error description: Schema for errors returned by the API type: object properties: type: type: string message: type: string validationErrors: type: array items: type: object properties: field: type: string validationMessage: type: string flow: title: Workflow description: Schema for a single Workflow type: object properties: id: type: string pattern: ^[A-Fa-f\d]{24}$ flowId: type: string pattern: ^[A-Fa-f\d]{24}$ applicationId: type: string pattern: ^[A-Fa-f\d]{24}$ creationDate: type: string format: date-time lastUpdated: type: string format: date-time createdById: type: string pattern: ^[A-Fa-f\d]{24}$ createdByType: type: string enum: - flow - user - apiToken lastUpdatedById: type: string pattern: ^[A-Fa-f\d]{24}$ lastUpdatedByType: type: string enum: - flow - user - apiToken name: type: string minLength: 1 maxLength: 255 description: type: string maxLength: 32767 shortDescription: type: string maxLength: 1024 iconData: type: string maxLength: 32767 pattern: ^data:image/(jpg|jpeg|png|svg\+xml);base64,[0-9a-zA-Z+/=]*$ docsUrl: type: string maxLength: 1024 category: type: string enum: - data - experience - logic - output - debug enabled: type: boolean defaultVersionId: type: string pattern: ^[A-Fa-f\d]{24}$ minimumAgentVersion: type: string pattern: ^(0|([1-9]\d*))\.(0|([1-9]\d*))\.(0|([1-9]\d*))$ flowClass: type: string enum: - cloud - edge - embedded - experience - customNode triggers: type: array items: type: object discriminator: propertyName: type oneOf: - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - appFile config: type: object properties: delete: type: boolean create: type: boolean update: type: boolean public: type: boolean private: type: boolean additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - appFile label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - customNodeStart - deviceCreate - deviceCommand - deviceIdConnect - deviceTagConnect - deviceIdDisconnect - deviceTagDisconnect - inboundEmail - notebook - onBoot - onConnect - onDisconnect - resourceJobComplete - resourceJobIteration - resourceJobIterationTimeout - udp - webhook config: type: object additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - customNodeStart - deviceCreate - deviceCommand - deviceIdsTagsConnect - deviceIdsTagsDisconnect - eeaInit - flowError - inboundEmail - notebook - onBoot - onConnect - onDisconnect - resourceJobComplete - resourceJobIteration - resourceJobIterationTimeout - udp - webhook label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number triggerId: type: string maxLength: 48 id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - beckhoff config: type: object properties: localAmsNetId: type: string maxLength: 1024 localAdsPort: type: string maxLength: 1024 targetAmsNetId: type: string maxLength: 1024 targetAdsPort: type: string maxLength: 1024 routerHost: type: string maxLength: 1024 routerTcpPort: type: string maxLength: 1024 cycleTimeMs: type: integer minimum: 10 maximum: 3600000 subscriptions: type: array items: type: object properties: name: type: string maxLength: 1024 maxItems: 100 configName: type: string maxLength: 1024 additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - beckhoff label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - dataTable config: type: object properties: bulkInsert: type: boolean delete: type: boolean insert: type: boolean update: type: boolean additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - dataTable label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - integration config: type: object properties: connect: type: boolean message: type: boolean disconnect: type: boolean failure: type: boolean additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - azureEventHub - googlePubSub - mqtt - particle - sqs - websocket label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number triggerId: type: string maxLength: 48 id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - deviceId - deviceTag config: type: object properties: attributeBlacklist: type: array maxItems: 100 items: type: string pattern: ^[0-9a-zA-Z_-]{1,255}$ attributeWhitelist: type: array maxItems: 100 items: type: string pattern: ^[0-9a-zA-Z_-]{1,255}$ maxAge: type: number triggerOn: type: string enum: - batch - individual - both batchBehavior: type: string enum: - once - each allowInvalid: type: boolean additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - deviceIdsTags - device - deviceTag label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 timeUnit: type: string maxLength: 48 maxAgeToggle: type: boolean allowedAttributeType: type: string enum: - attributeWhitelist - any - attributeBlacklist additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - deviceIdInactivity - deviceTagInactivity config: type: object properties: seconds: type: number additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - deviceIdsTagsInactivity label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - direct config: type: object properties: {} additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - direct label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - endpoint config: type: object properties: experienceVersion: type: string minLength: 1 maxLength: 255 additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - endpoint label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - event config: type: object properties: subject: type: string maxLength: 255 new: type: boolean acknowledged: type: boolean resolved: type: boolean additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - event label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - fileTail config: type: object properties: path: type: string maxLength: 1024 encoding: type: string maxLength: 48 byteLength: type: string maxLength: 48 delimiter: type: string maxLength: 48 additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - fileTail label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - fileWatch config: type: object properties: path: type: string maxLength: 1024 fileAdded: type: boolean fileChanged: type: boolean fileRemoved: type: boolean directoryAdded: type: boolean directoryRemoved: type: boolean additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - fileWatch label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - flowError config: type: object properties: scope: type: string enum: - local - global - experience - cloud additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - flowError label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - mqttTopic config: type: object properties: integrationId: type: string enum: - losant - local - external additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - mqtt label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number triggerId: type: string maxLength: 48 id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - onSync config: type: object properties: syncTypes: type: array maxItems: 3 minItems: 1 items: type: string enum: - application - device - peripheral additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - onSync label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - opcua config: type: object properties: uri: type: string format: uri maxLength: 1024 securityPolicy: type: string maxLength: 255 securityMode: type: string maxLength: 255 username: type: string maxLength: 1024 password: type: string maxLength: 1024 cert: type: string maxLength: 32767 privateKey: type: string maxLength: 32767 nameSpace: type: string maxLength: 255 identifier: type: string maxLength: 255 samplingInterval: type: string maxLength: 255 eventFilter: type: array maxItems: 100 items: type: string maxLength: 255 configName: type: string maxLength: 1024 additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - opcua label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - redis config: type: object properties: host: type: string maxLength: 1024 port: type: string maxLength: 16 password: type: string maxLength: 1024 topic: type: string maxLength: 1024 fileAdded: type: boolean fileChanged: type: boolean fileRemoved: type: boolean directoryAdded: type: boolean directoryRemoved: type: boolean additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - redisTrigger label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - request config: type: object properties: method: type: string enum: - '*' - delete - get - options - patch - post - put route: type: string maxLength: 1024 additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - request label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number triggerId: type: string maxLength: 48 id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - serial config: type: object properties: path: type: string maxLength: 1024 baudRate: type: number dataBits: type: number stopBits: type: number parity: type: string maxLength: 8 rtscts: type: boolean encoding: type: string maxLength: 48 writeOnOpen: type: string maxLength: 1024 writeOnOpenEncoding: type: string maxLength: 48 byteLength: type: string maxLength: 48 delimiter: type: string maxLength: 48 delimiterEncoding: type: string maxLength: 48 additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - serial label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 parseBy: type: string enum: - byteLength - delimiter additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - snmpTrap config: type: object properties: udpPort: type: string maxLength: 5 snmpTrapConfig: type: object properties: community: type: string maxLength: 1024 user: type: object properties: name: type: string maxLength: 1024 securityLevel: type: string enum: - none - auth - authAndEncrypt authMethod: type: string enum: - sha - md5 authKey: type: string maxLength: 1024 encryptionMethod: type: string enum: - aes - des encryptionKey: type: string maxLength: 1024 required: - name - securityLevel additionalProperties: false additionalProperties: false required: - udpPort - snmpTrapConfig additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - snmpTrap label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - timer config: type: object properties: seconds: type: number cron: type: string maxLength: 255 tz: type: string maxLength: 255 additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - timer label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 timerTypeSelect: type: string enum: - cronWeekly - seconds - cron timeAt: type: string maxLength: 255 timezone: type: string maxLength: 255 weekdays: type: array maxItems: 7 items: type: number additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false - type: object properties: key: type: string maxLength: 1024 type: type: string enum: - virtualButton config: type: object additionalProperties: false meta: type: object properties: category: type: string enum: - trigger name: type: string enum: - virtualButton label: type: string minLength: 1 maxLength: 255 x: type: number y: type: number uiId: type: string maxLength: 48 groupId: type: string maxLength: 48 description: type: string maxLength: 32767 icon: type: string maxLength: 1024 color: type: string maxLength: 1024 inputCount: type: number outputCount: type: number id: type: string maxLength: 48 payload: type: string maxLength: 262144 deviceId: oneOf: - type: string pattern: ^[A-Fa-f\d]{24}$ - type: string enum: - '' - type: 'null' additionalProperties: false required: - category - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 required: - type - meta additionalProperties: false nodes: type: array items: type: object properties: id: type: string maxLength: 1024 type: type: string minLength: 1 maxLength: 1024 config: type: object meta: type: object properties: category: type: string minLength: 1 maxLength: 1024 name: type: string minLength: 1 maxLength: 1024 label: type: string minLength: 1 maxLength: 255 description: type: string maxLength: 32767 x: type: number y: type: number groupId: type: string maxLength: 1024 required: - name outputIds: type: array items: type: array items: type: string maxLength: 48 minLength: 1 maxItems: 100 maxItems: 100 additionalProperties: false required: - type - meta customNodeConfig: type: object properties: outputCount: type: number enum: - 1 - 2 resultMode: type: string enum: - optional - required - none resultDescription: type: string maxLength: 32767 fields: type: array maxItems: 100 items: type: object discriminator: propertyName: type oneOf: - type: object properties: type: type: string enum: - checkbox label: type: string minLength: 1 maxLength: 1024 id: type: string minLength: 1 maxLength: 1024 description: type: string maxLength: 32767 defaultValue: type: boolean additionalProperties: false required: - type - label - type: object properties: type: type: string enum: - select label: type: string minLength: 1 maxLength: 1024 id: type: string minLength: 1 maxLength: 1024 description: type: string maxLength: 32767 defaultValue: type: string minLength: 1 maxLength: 1024 options: type: array minItems: 1 maxItems: 100 items: type: object properties: label: type: string maxLength: 1024 value: type: string minLength: 1 maxLength: 1024 additionalProperties: false required: - value additionalProperties: false required: - type - label - defaultValue - options - type: object properties: type: type: string enum: - stringTemplate label: type: string minLength: 1 maxLength: 1024 id: type: string minLength: 1 maxLength: 1024 description: type: string maxLength: 32767 defaultValue: type: string maxLength: 1024 required: type: boolean validRegExp: type: string maxLength: 1024 additionalProperties: false required: - type - label - type: object properties: type: type: string enum: - numberTemplate label: type: string minLength: 1 maxLength: 1024 id: type: string minLength: 1 maxLength: 1024 description: type: string maxLength: 32767 defaultValue: type: number required: type: boolean validMin: type: number validMax: type: number additionalProperties: false required: - type - label - type: object properties: type: type: string enum: - jsonTemplate label: type: string minLength: 1 maxLength: 1024 id: type: string minLength: 1 maxLength: 1024 description: type: string maxLength: 32767 defaultValue: type: string maxLength: 32767 required: type: boolean additionalProperties: false required: - type - label - type: object properties: type: type: string enum: - payloadPath label: type: string minLength: 1 maxLength: 1024 id: type: string minLength: 1 maxLength: 1024 description: type: string maxLength: 32767 required: type: boolean additionalProperties: false required: - type - label - type: object properties: type: type: string enum: - section label: type: string minLength: 1 maxLength: 1024 id: type: string minLength: 1 maxLength: 1024 description: type: string maxLength: 32767 additionalProperties: false required: - type - label additionalProperties: false required: - outputCount - resultMode - fields customNodeSupports: type: array maxItems: 1 items: type: string enum: - cloud - edge customNodeUseCount: type: number globals: type: array maxItems: 100 items: type: object properties: key: type: string pattern: ^[0-9a-zA-Z_-]{1,255}$ json: type: string minLength: 1 maxLength: 32767 additionalProperties: false required: - key - json deletedInDevelop: type: boolean stats: type: object properties: runCount: type: number errorCount: type: number byVersion: type: object patternProperties: .*: type: object properties: runCount: type: number errorCount: type: number _customNodes: type: array items: $ref: '#/components/schemas/flow' _customNodeVersions: type: array items: $ref: '#/components/schemas/flowVersion' integration: title: Integration description: Schema for a single Integration type: object properties: id: type: string pattern: ^[A-Fa-f\d]{24}$ integrationId: type: string pattern: ^[A-Fa-f\d]{24}$ applicationId: type: string pattern: ^[A-Fa-f\d]{24}$ creationDate: type: string format: date-time lastUpdated: type: string format: date-time name: type: string minLength: 1 maxLength: 255 credentialName: type: string minLength: 1 maxLength: 255 integrationType: type: string enum: - azureEventHub - googlePubSub - mqtt - particle - sqs - websocket enabled: type: boolean topics: type: array items: type: string minLength: 1 maxLength: 1024 uniqueItems: true azureEventHubConfig: type: object properties: hubName: type: string maxLength: 256 minLength: 1 hostName: type: string maxLength: 256 minLength: 1 consumerGroup: type: string maxLength: 256 minLength: 1 connectionString: type: string minLength: 1 maxLength: 1024 additionalProperties: false oneOf: - required: - hubName - consumerGroup - connectionString - required: - hubName - consumerGroup - hostName googlePubSubConfig: type: object properties: projectId: type: string maxLength: 255 minLength: 1 keyJson: type: string maxLength: 32767 minLength: 4 additionalProperties: false mqttConfig: type: object properties: clientId: type: string minLength: 1 maxLength: 1024 username: type: string minLength: 1 maxLength: 1024 password: type: string minLength: 1 maxLength: 1024 clean: type: boolean port: type: number minimum: 1 maximum: 65535 protocol: type: string enum: - mqtt - mqtts - ws - wss host: type: string minLength: 1 maxLength: 1024 privateKey: type: string maxLength: 32767 minLength: 4 certificate: type: string maxLength: 32767 minLength: 4 caCertificate: type: string maxLength: 32767 minLength: 4 disableSSLVerification: type: boolean protocolVersion: type: string enum: - 3.1.1 - '5' additionalProperties: false required: - port - protocol - host particleConfig: type: object properties: accessToken: type: string minLength: 1 maxLength: 1024 productSlugOrId: type: string minLength: 1 maxLength: 1024 orgSlugOrId: type: string minLength: 1 maxLength: 1024 deviceNameOrId: type: string minLength: 1 maxLength: 1024 additionalProperties: false required: - accessToken sqsConfig: type: object properties: accessKeyId: type: string minLength: 4 maxLength: 128 secretAccessKey: type: string minLength: 4 maxLength: 128 region: type: string minLength: 4 maxLength: 128 queueUrl: type: string minLength: 1 maxLength: 256 additionalProperties: false required: - queueUrl websocketConfig: type: object properties: url: type: string minLength: 1 maxLength: 1024 disableSSLVerification: type: boolean username: type: string minLength: 1 maxLength: 1024 password: type: string minLength: 1 maxLength: 1024 privateKey: type: string maxLength: 32767 minLength: 4 certificate: type: string maxLength: 32767 minLength: 4 caCertificate: type: string maxLength: 32767 minLength: 4 headers: type: array maxItems: 50 items: type: object properties: headerKey: type: string minLength: 1 maxLength: 1024 headerValue: type: string minLength: 1 maxLength: 1024 additionalProperties: false required: - headerKey - headerValue additionalProperties: false required: - url status: type: object properties: lastKeepAlive: type: number nextAttempt: type: number connectInfo: type: object properties: ts: type: - number - 'null' disconnectInfo: type: object properties: ts: type: - number - 'null' error: type: string integrations: title: Integrations description: Schema for a collection of Integrations type: object properties: items: type: array items: $ref: '#/components/schemas/integration' count: type: integer totalCount: type: integer perPage: type: integer page: type: integer filter: type: string filterField: type: string sortField: type: string sortDirection: type: string enum: - asc - desc - ASC - DESC - '' applicationId: type: string pattern: ^[A-Fa-f\d]{24}$ success: title: Success description: Schema for reporting a successful operation type: object properties: success: type: boolean enum: - true credentialPost: title: Credential Post description: Schema for a Credential creation request type: object properties: name: type: string minLength: 1 maxLength: 255 description: type: string maxLength: 32767 enabled: type: boolean type: type: string enum: - aws - azure - gcp - http - sendgrid - twilio - loggly - jwt - whatsapp - sql - mongodb - mailgun - snowflake - git - datadog - certificateKeyPair awsConfig: type: object properties: accessKeyId: type: string minLength: 16 maxLength: 128 secretAccessKey: type: string minLength: 4 maxLength: 128 region: type: string minLength: 1 maxLength: 128 additionalProperties: false required: - accessKeyId - secretAccessKey - region azureConfig: type: object properties: account: type: string maxLength: 128 accountKey: type: string minLength: 4 maxLength: 128 additionalProperties: false required: - accountKey gcpConfig: type: object properties: keyJson: type: string minLength: 1 maxLength: 8192 additionalProperties: false required: - keyJson httpConfig: type: object properties: uriMatch: type: string minLength: 8 maxLength: 1024 authMethod: type: string enum: - header - queryParam - basicAuth - clientCertificate publicValue: type: string maxLength: 8196 secretValue: type: string maxLength: 8196 additionalProperties: false required: - uriMatch - authMethod - secretValue sendgridConfig: type: object properties: apiKey: type: string minLength: 4 maxLength: 128 additionalProperties: false required: - apiKey twilioConfig: type: object properties: accountSid: type: string minLength: 4 maxLength: 128 apiKeySid: type: string minLength: 4 maxLength: 128 apiKeySecret: type: string minLength: 4 maxLength: 128 additionalProperties: false required: - accountSid - apiKeySid - apiKeySecret logglyConfig: type: object properties: customerToken: type: string minLength: 1 maxLength: 128 additionalProperties: false required: - customerToken jwtConfig: type: object properties: issuer: type: string maxLength: 1024 algorithm: type: string enum: - HS256 - HS384 - HS512 - RS256 - RS384 - RS512 - ES256 - ES384 - ES512 secret: type: string minLength: 1 maxLength: 4096 additionalProperties: false required: - algorithm - secret whatsappConfig: type: object properties: accessToken: type: string minLength: 1 maxLength: 1024 fromNumberId: type: string minLength: 1 maxLength: 128 additionalProperties: false required: - accessToken - fromNumberId sqlConfig: type: object properties: system: type: string enum: - mssql - mysql - pg host: type: string minLength: 1 maxLength: 256 port: oneOf: - type: integer minimum: 1 maximum: 65535 - type: 'null' username: type: string minLength: 1 maxLength: 256 password: type: string minLength: 1 maxLength: 256 secureConnection: type: boolean caCertificate: type: string maxLength: 8196 disableSSLVerification: type: boolean additionalProperties: false required: - system - host - username - password mongodbConfig: type: object properties: connectionUri: type: string minLength: 1 maxLength: 2048 additionalProperties: false required: - connectionUri mailgunConfig: type: object properties: apiKey: type: string minLength: 4 maxLength: 128 additionalProperties: false required: - apiKey snowflakeConfig: type: object properties: host: type: string minLength: 1 maxLength: 128 username: type: string minLength: 1 maxLength: 128 privateKey: type: string maxLength: 8196 generatePrivateKey: type: boolean additionalProperties: false anyOf: - required: - host - username - privateKey - required: - host - username - generatePrivateKey gitConfig: type: object properties: type: type: string enum: - ssh-key - http-password cloneUrl: type: string minLength: 5 maxLength: 1024 username: type: string maxLength: 128 committerName: type: string maxLength: 128 committerEmail: type: string maxLength: 128 generatePrivateKey: type: boolean secretValue: type: string maxLength: 8196 additionalProperties: false anyOf: - required: - type - cloneUrl - generatePrivateKey - required: - type - cloneUrl datadogConfig: type: object properties: secretValue: type: string maxLength: 256 site: type: string minLength: 1 maxLength: 128 additionalProperties: false required: - secretValue certificateKeyPairConfig: type: object properties: certificate: type: string maxLength: 8192 privateKey: type: string maxLength: 8196 storeAsCertAuthority: type: boolean additionalProperties: false required: - certificate - privateKey additionalProperties: false required: - name - type credential: title: Credential description: Schema for a single Credential type: object properties: id: type: string pattern: ^[A-Fa-f\d]{24}$ credentialId: type: string pattern: ^[A-Fa-f\d]{24}$ applicationId: type: string pattern: ^[A-Fa-f\d]{24}$ creationDate: type: string format: date-time lastUpdated: type: string format: date-time createdById: type: string pattern: ^[A-Fa-f\d]{24}$ createdByType: type: string enum: - flow - user - apiToken lastUpdatedById: type: string pattern: ^[A-Fa-f\d]{24}$ lastUpdatedByType: type: string enum: - flow - user - apiToken name: type: string minLength: 1 maxLength: 255 description: type: string maxLength: 32767 enabled: type: boolean type: type: string enum: - aws - azure - gcp - http - sendgrid - twilio - loggly - jwt - whatsapp - sql - mongodb - mailgun - snowflake - git - datadog - certificateKeyPair awsConfig: type: object properties: accessKeyId: type: string minLength: 16 maxLength: 128 region: type: string minLength: 1 maxLength: 128 additionalProperties: false required: - accessKeyId - region azureConfig: type: object properties: account: type: string maxLength: 128 additionalProperties: false gcpConfig: type: object properties: keyMetaJson: type: string minLength: 1 maxLength: 8192 additionalProperties: false required: - keyMetaJson httpConfig: type: object properties: uriMatch: type: string minLength: 8 maxLength: 1024 authMethod: type: string enum: - header - queryParam - basicAuth - clientCertificate publicValue: type: string maxLength: 8196 additionalProperties: false required: - uriMatch - authMethod - publicValue sendgridConfig: type: object properties: {} additionalProperties: false twilioConfig: type: object properties: accountSid: type: string minLength: 4 maxLength: 128 apiKeySid: type: string minLength: 4 maxLength: 128 additionalProperties: false required: - accountSid - apiKeySid logglyConfig: type: object properties: {} additionalProperties: false jwtConfig: type: object properties: issuer: type: string maxLength: 1024 algorithm: type: string enum: - HS256 - HS384 - HS512 - RS256 - RS384 - RS512 - ES256 - ES384 - ES512 additionalProperties: false required: - algorithm whatsappConfig: type: object properties: fromNumberId: type: string minLength: 1 maxLength: 128 additionalProperties: false required: - fromNumberId sqlConfig: type: object properties: system: type: string enum: - mssql - mysql - pg host: type: string minLength: 1 maxLength: 256 port: type: integer minimum: 1 maximum: 65535 username: type: string minLength: 1 maxLength: 256 secureConnection: type: boolean caCertificate: type: string maxLength: 8196 disableSSLVerification: type: boolean additionalProperties: false required: - system - host - username mongodbConfig: type: object properties: {} additionalProperties: false mailgunConfig: type: object properties: {} additionalProperties: false snowflakeConfig: type: object properties: host: type: string minLength: 1 maxLength: 128 username: type: string minLength: 1 maxLength: 128 publicKey: type: string minLength: 1 maxLength: 8192 required: - host - username - publicKey additionalProperties: false gitConfig: type: object properties: type: type: string enum: - ssh-key - http-password cloneUrl: type: string minLength: 5 maxLength: 1024 publicKey: type: string maxLength: 8192 username: type: string maxLength: 128 committerName: type: string maxLength: 128 committerEmail: type: string maxLength: 128 required: - type - cloneUrl additionalProperties: false datadogConfig: type: object properties: site: type: string minLength: 1 maxLength: 128 additionalProperties: false certificateKeyPairConfig: type: object properties: certificate: type: string maxLength: 8192 info: type: object properties: serialNumber: type: string minLength: 1 maxLength: 1024 fingerprint: type: string minLength: 1 maxLength: 1024 commonName: type: string maxLength: 1024 issuerName: type: string maxLength: 1024 notValidBefore: type: string format: date-time notValidAfter: type: string format: date-time storeAsCertAuthority: type: boolean additionalProperties: false additionalProperties: false required: - name - type credentialPatch: title: Credential Patch description: Schema for a Credential update request type: object properties: name: type: string minLength: 1 maxLength: 255 description: type: string maxLength: 32767 enabled: type: boolean awsConfig: type: object properties: accessKeyId: type: string minLength: 16 maxLength: 128 secretAccessKey: type: string minLength: 4 maxLength: 128 region: type: string minLength: 1 maxLength: 128 additionalProperties: false azureConfig: type: object properties: account: type: string maxLength: 128 accountKey: type: string minLength: 4 maxLength: 128 additionalProperties: false gcpConfig: type: object properties: keyJson: type: string minLength: 1 maxLength: 8192 additionalProperties: false httpConfig: type: object properties: uriMatch: type: string minLength: 8 maxLength: 1024 authMethod: type: string enum: - header - queryParam - basicAuth - clientCertificate publicValue: type: string maxLength: 8196 secretValue: type: string maxLength: 8196 additionalProperties: false sendgridConfig: type: object properties: apiKey: type: string minLength: 4 maxLength: 128 additionalProperties: false twilioConfig: type: object properties: accountSid: type: string minLength: 4 maxLength: 128 apiKeySid: type: string minLength: 4 maxLength: 128 apiKeySecret: type: string minLength: 4 maxLength: 128 additionalProperties: false logglyConfig: type: object properties: customerToken: type: string minLength: 1 maxLength: 128 additionalProperties: false jwtConfig: type: object properties: issuer: type: string maxLength: 1024 algorithm: type: string enum: - HS256 - HS384 - HS512 - RS256 - RS384 - RS512 - ES256 - ES384 - ES512 secret: type: string minLength: 1 maxLength: 4096 additionalProperties: false whatsappConfig: type: object properties: accessToken: type: string minLength: 1 maxLength: 1024 fromNumberId: type: string minLength: 1 maxLength: 128 additionalProperties: false sqlConfig: type: object properties: system: type: string enum: - mssql - mysql - pg host: type: string minLength: 1 maxLength: 256 port: oneOf: - type: integer minimum: 1 maximum: 65535 - type: 'null' username: type: string minLength: 1 maxLength: 256 password: type: string minLength: 1 maxLength: 256 secureConnection: type: boolean caCertificate: type: string maxLength: 8196 disableSSLVerification: type: boolean additionalProperties: false mongodbConfig: type: object properties: connectionUri: type: string minLength: 1 maxLength: 2048 additionalProperties: false mailgunConfig: type: object properties: apiKey: type: string minLength: 4 maxLength: 128 additionalProperties: false snowflakeConfig: type: object properties: host: type: string minLength: 1 maxLength: 128 username: type: string minLength: 1 maxLength: 128 privateKey: type: string maxLength: 8196 generatePrivateKey: type: boolean additionalProperties: false gitConfig: type: object properties: type: type: string enum: - ssh-key - http-password cloneUrl: type: string minLength: 5 maxLength: 1024 username: type: string maxLength: 128 committerName: type: string maxLength: 128 committerEmail: type: string maxLength: 128 generatePrivateKey: type: boolean secretValue: type: string maxLength: 8196 additionalProperties: false datadogConfig: type: object properties: secretValue: type: string maxLength: 256 site: type: string minLength: 1 maxLength: 128 additionalProperties: false certificateKeyPairConfig: type: object properties: certificate: type: string maxLength: 8192 privateKey: type: string maxLength: 8196 storeAsCertAuthority: type: boolean additionalProperties: false additionalProperties: false flows: title: Workflows description: Schema for a collection of Workflows type: object properties: items: type: array items: $ref: '#/components/schemas/flow' count: type: integer totalCount: type: integer perPage: type: integer page: type: integer filter: type: string filterField: type: string sortField: type: string sortDirection: type: string enum: - asc - desc - ASC - DESC - '' applicationId: type: string pattern: ^[A-Fa-f\d]{24}$ flowClass: type: string enum: - cloud - edge - embedded - experience - customNode customNodes: type: array items: $ref: '#/components/schemas/flow' customNodeVersions: type: array items: $ref: '#/components/schemas/flowVersion' credentialLinkedResources: title: Credential Linked Resources description: The body of an credential linked resources response type: object properties: integrations: $ref: '#/components/schemas/integrations' flows: $ref: '#/components/schemas/flows' flowVersions: $ref: '#/components/schemas/flowVersions' additionalProperties: false flowVersion: title: Workflow Version description: Schema for a single Workflow Version oneOf: - description: Schema for a single Cloud/Edge/Embedded/Custom Node Workflow Version type: object not: required: - flowClass properties: id: type: string pattern: ^[A-Fa-f\d]{24}$ flowVersionId: type: string pattern: ^[A-Fa-f\d]{24}$ flowId: type: string pattern: ^[A-Fa-f\d]{24}$ applicationId: type: string pattern: ^[A-Fa-f\d]{24}$ creationDate: type: string format: date-time lastUpdated: type: string format: date-time createdById: type: string pattern: ^[A-Fa-f\d]{24}$ createdByType: type: string enum: - flow - user - apiToken lastUpdatedById: type: string pattern: ^[A-Fa-f\d]{24}$ lastUpdatedByType: type: string enum: - flow - user - apiToken version: type: string minLength: 1 maxLength: 255 notes: type: string maxLength: 32767 enabled: type: boolean triggers: $ref: '#/components/schemas/flow/properties/triggers' nodes: $ref: '#/components/schemas/flow/properties/nodes' globals: type: array maxItems: 100 items: type: object properties: key: type: string pattern: ^[0-9a-zA-Z_-]{1,255}$ json: type: string minLength: 1 maxLength: 32767 additionalProperties: false required: - key - json minimumAgentVersion: type: string pattern: ^(0|([1-9]\d*))\.(0|([1-9]\d*))\.(0|([1-9]\d*))$ customNodeConfig: $ref: '#/components/schemas/flow/properties/customNodeConfig' stats: type: object properties: runCount: type: number errorCount: type: number byVersion: type: object patternProperties: .*: type: object properties: runCount: type: number errorCount: type: number _customNodes: type: array items: $ref: '#/components/schemas/flow' _customNodeVersions: type: array items: $ref: '#/components/schemas/flowVersion' - description: Schema for a single Experience Workflow Version type: object required: - flowClass properties: id: type: string pattern: ^[A-Fa-f\d]{24}$ flowVersionId: type: string pattern: ^[A-Fa-f\d]{24}$ flowId: type: string pattern: ^[A-Fa-f\d]{24}$ applicationId: type: string pattern: ^[A-Fa-f\d]{24}$ creationDate: type: string format: date-time lastUpdated: type: string format: date-time createdById: type: string pattern: ^[A-Fa-f\d]{24}$ createdByType: type: string enum: - flow - user - apiToken lastUpdatedById: type: string pattern: ^[A-Fa-f\d]{24}$ lastUpdatedByType: type: string enum: - flow - user - apiToken name: type: string minLength: 1 maxLength: 255 description: type: string maxLength: 32767 flowClass: type: string enum: - experience versions: type: array items: type: string minLength: 1 maxLength: 255 enabled: type: boolean triggers: $ref: '#/components/schemas/flow/properties/triggers' nodes: $ref: '#/components/schemas/flow/properties/nodes' globals: type: array maxItems: 100 items: type: object properties: key: type: string pattern: ^[0-9a-zA-Z_-]{1,255}$ json: type: string minLength: 1 maxLength: 32767 additionalProperties: false required: - key - json stats: type: object properties: runCount: type: number errorCount: type: number byVersion: type: object patternProperties: .*: type: object properties: runCount: type: number errorCount: type: number _customNodes: type: array items: $ref: '#/components/schemas/flow' _customNodeVersions: type: array items: $ref: '#/components/schemas/flowVersion' credentials: title: Credentials description: Schema for a collection of Credentials type: object properties: items: type: array items: $ref: '#/components/schemas/credential' count: type: integer totalCount: type: integer perPage: type: integer page: type: integer filter: type: string filterField: type: string sortField: type: string sortDirection: type: string enum: - asc - desc - ASC - DESC - '' applicationId: type: string pattern: ^[A-Fa-f\d]{24}$ securitySchemes: bearerAuth: type: http scheme: bearer x-derived-from: format: bravado 1.0 by: all/0-working/bravado-to-openapi.py (roadmap#799) note: 'every action keeps its own path: resource.path + action.path'