Integrations Context

List Context Integrations

get

Returns an array of context integrations.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

List of Context Integrations Requested, or an array containing the new/updated Context Integration after a Create or Update operation.

application/json
get
/api/v1/integrations/context

Create Context Integration

post

Creates a context integration from the data that's been supplied. Do not provide an id. IDs are auto generated

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

List of Context Integrations Requested, or an array containing the new/updated Context Integration after a Create or Update operation.

namestringRequired

The name of the context integration

typestring · enumRequired

The type of the context integration. The configuration parameters are dependent on this value.

Possible values:
enabledbooleanRequired

The state of the context integration. Whether to auto update or not.

updateintervalinteger · int32 · min: 3600 · max: 604800Required

The number of seconds by which to poll the integration.

Example: 86400
Responses
post
/api/v1/integrations/context

Fetch Context Integration

get

Fetches a specific context integration from the ID supplied in the path.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The ID of the context integration to be returned.

Responses
chevron-right
200

List of Context Integrations Requested, or an array containing the new/updated Context Integration after a Create or Update operation.

application/json
get
/api/v1/integrations/context/{id}

Update Context Integration

put

Update a context integration given the provided object. This does not do a diff. You must send the complete object.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The ID of the context integration to be updated

Body

List of Context Integrations Requested, or an array containing the new/updated Context Integration after a Create or Update operation.

namestringRequired

The name of the context integration

typestring · enumRequired

The type of the context integration. The configuration parameters are dependent on this value.

Possible values:
enabledbooleanRequired

The state of the context integration. Whether to auto update or not.

updateintervalinteger · int32 · min: 3600 · max: 604800Required

The number of seconds by which to poll the integration.

Example: 86400
Responses
chevron-right
200

List of Context Integrations Requested, or an array containing the new/updated Context Integration after a Create or Update operation.

application/json
put
/api/v1/integrations/context/{id}

Delete Context Integration

delete

Deletes a context integration

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The ID of the context integration to be deleted

Responses
delete
/api/v1/integrations/context/{id}

No content

Dry Run/Test a Context Integration

get

Runs the specified context integration. Retuns a list of ip labels that would be imported when the context integration is run.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

The ID of the context integration to be test run.

Responses
chevron-right
200

List of IP Labels Requested

application/json
get
/api/v1/integrations/context/{id}/run

Run a Context Integration

put

Runs the specified context integration. Returns a list of ip labels that were imported.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

The ID of the context integration to be test run.

Responses
chevron-right
200

List of IP Labels Requested

application/json
put
/api/v1/integrations/context/{id}/run

Regenerate private/public keys.

put

Only applicable to Oracle Cloud.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

String ID of the role to get

Responses
chevron-right
200

List of Context Integrations Requested, or an array containing the new/updated Context Integration after a Create or Update operation.

application/json
put
/api/v1/integrations/context/{id}/regenkeys

Last updated