Integration resources
integration/apiproxy
APIProxy
Represents information needed to register and interact with an application’s
remote endpoint.
Example
{ "certificateAuthority": "-----BEGIN CERTIFICATE----- MIIBbjCCARSgAwIBAgIRANRbvVzTzBZOvMCb8BiKCLowCgYIKoZIzj0EAwIwJjEN MAsGA1UEChMEQWNtZTEVMBMGA1UEAxMMQWNtZSBSb290IENBMB4XDTE4MDExNTE4 NDgwN1oXDTI3MTEyNDE4NDgwN1owJjENMAsGA1UEChMEQWNtZTEVMBMGA1UEAxMM QWNtZSBSb290IENBMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEJ/80HR51+vau 7XH7zS7b8ABA0e/TdBOg1NznbnXdXil1tDvWloWuH5+/bbaiEg54wksJHFXaukw8 jhTLU7zT56MjMCEwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wCgYI KoZIzj0EAwIDSAAwRQIhALwAZh2KLFFC1qfb5CqFHExlXS0PUltax9PvQCN9P0vl AiBl7/st9u/JpERjJgirxJxOgKNlV6pq9ti75EfQtZZcQA== -----END CERTIFICATE-----", "clientCertificate": "-----BEGIN CERTIFICATE----- MIIBczCCARigAwIBAgIRALD3Vz81Pq10g7n4eAkOsCYwCgYIKoZIzj0EAwIwJjEN MAsGA1UEChMEQWNtZTEVMBMGA1UEAxMMQWNtZSBSb290IENBMB4XDTE4MDExNzA2 NTM1MloXDTI3MTEyNjA2NTM1MlowGDEWMBQGA1UEAxMNY2xhaXJlLWNsaWVudDBZ MBMGByqGSM49AgEGCCqGSM49AwEHA0IABOmzPJj+t25T148eQH5gVrZ7nHwckF5O evJQ3CjSEMesjZ/u7cW8IBfXlxZKHxl91IEbbB3svci4c8pycUNZ2kujNTAzMA4G A1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAjAMBgNVHRMBAf8EAjAA MAoGCCqGSM49BAMCA0kAMEYCIQCjAAmkQpTua0HR4q6jnePaFBp/JMXwTXTxzbV6 peGbBQIhAP+1OR8GFnn2PlacwHqWXHwkvy6CLPVikvgtwEdB6jH8 -----END CERTIFICATE-----", "clientCertificateKey": "-----BEGIN EC PRIVATE KEY----- MHcCAQEEIGOXJI/123456789oamOu4tQAIKFdbyvkIJg9GME0mHzoAoGCCqGSM49 AwEHoUQDQgAE6bM8mP123456789AfmBWtnucfByQXk568lDcKNIQx6yNn+7txbwg F9eXFkofGX3UgRtsHe123456789xQ1naSw== -----END EC PRIVATE KEY-----", "disabled": false, "endpoint": "https://api.remoteserver.com/remoteroute", "name": "the name", "operation": "GET", "protected": false }
Relations
Retrieves the list of API proxies.
Parameters:
Creates a new API proxy.
Deletes the API proxy with the given ID.
Retrieves the API proxy with the given ID.
Updates the API proxy with the given ID.
Allows a system to send a remote request to the API proxy based on the
operation attribute.
Allows a system to send a remote request to the API proxy based on the
operation attribute.
Attributes
Type: string
Contains the client certificate that will be used to connect
to the remote endpoint. If provided, the private key associated with this
certificate must also be configured.
Type: string
Contains the key associated with the clientCertificate. It must be
provided only when clientCertificate has been configured.
Type: []string
Contains tags that can only be set during creation, must all start
with the '@' prefix, and should only be used by external systems.
Defines the operation that is currently handled by the service.
Default value:
"GET"
Call
Can be used to send a remote request to an API proxy.
Relations
Allows a system to send a remote request to the API proxy based on the
operation attribute.
Allows a system to send a remote request to the API proxy based on the
operation attribute.
integration/app
App
Represents an application that can be installed.
Example
{ "beta": false, "name": "the name" }
Attributes
Category
Allows you to categorize services.
Example
{ "name": "the name" }
Attributes
InstalledApp
Represents an installed application.
Example
{ "additionalConfiguration": false, "checkPublicEndpoint": false, "name": "the name", "protected": false, "status": "Unknown" }
Relations
Installs a new app.
Deletes the application with the given ID.
Parameters:
Retrieves the application with the given ID.
Updates the application with the given ID.
Returns the logs for an application.
Attributes
Type: boolean
If true, will look for the public endpoints and store them as annotations in the
installed app.
Status of the application.
Default value:
"Unknown"
Log
Retrieves the logs of a deployed application.
Relations
Returns the logs for an application.
Attributes
integration/automation
Automation
Allows you to define some JavaScript code and specify the conditions under which it should
be executed.
Example
{ "condition": "function when(m, params) { return { continue: true }}", "disabled": false, "immediateExecution": false, "name": "the name", "protected": false, "tokenRenew": false, "trigger": "Time" }
Relations
Retrieves the list of automations.
Parameters:
Creates a new Automation.
Deletes the automation with the given ID.
Parameters:
Retrieves the automation with the given ID.
Updates the automation with the given ID.
Allows a system to trigger the automation if its trigger property is set
to RemoteCall.
Allows a system to trigger the automation if its trigger property is set
to RemoteCall.
Attributes
Type: string
Condition contains the code that will be executed to decide if any action(s)
should be executed. Providing a condition for an automation with a
"Webhook" trigger type will have no impact as the condition will not be
evaluated. If no condition is defined, then the automation action(s) will be
executed; this behaves akin to a condition that always succeeds.
Type: _automation_events
Contains the identity and operation an event must have to trigger the
automation.
Type: boolean
If set and the trigger is of type Time, the automation will be run at create or
update before being scheduled.
Type: string
Holds the unique access token used as a password to trigger the
authentication. It will be visible only after creation.
Controls when the automation should be triggered.
Default value:
"Time"
AutomationTemplate
Templates that can be used in automations.
Example
{ "kind": "Condition", "name": "the name" }
Relations
Retrieves the list of automation templates.
Retrieves the template with the given ID.
Attributes
Trigger
Can be used to remotely trigger an automation.
Relations
Allows a system to trigger the automation if its trigger property is set
to RemoteCall.
Allows a system to trigger the automation if its trigger property is set
to RemoteCall.
Most Popular
