Integration service (v1)

Download OpenAPI specification:Download

co.brick: aiops@cobrick.com URL: https://cobrick.com License: Commercial

Integrations

Get the list of integrations and their link statuses

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
401
500

Content type

application/json

[{"system": "string",
"status": "INITIATED"
}
]

Install integration with an external system

query Parameters

system

required

string

External system name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

403
422

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

Remove an integration with an external system

query Parameters

system

required

string

External system name

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

200
500

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}

OAuth

OAuth 2.0 link flow callback

path Parameters

code required	string An authorization code to be exchanged for an access token
state required	string <uuid> A unique identifier of the flow, the same as in the initial request

header Parameters

X-Scope-OrgID	string Tenant header
Api-Version	string API version

Responses

Response samples

301
404
422
501

Content type

application/json

{"_links": { },
"_embedded": {"property1": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
],
"property2": [{"_links": {"empty": true
},
"_embedded": {"empty": true
}
}
]
},
"message": "string",
"logref": "string",
"path": "string"
}