Integration

Operations on source integrations.

List integration data for account

get/integrations

Lists integration data for Trend Micro Cloud One account. One user can have multiple organizations/repositories/source control services linked to their account. The integration data can be different depending on the source control service used, GitHub, BitBucket, GitLab, etc.

SecurityCloudOneApiKey
Request
query Parameters
cursor
string [ 20 .. 1200 ] ^[0-9a-zA-Z-_]+$

An encoded value used to retrieve the next set of results for a query that returns more results than the provided limit. It uses the next value from the previous response.

Example: cursor=eyJrIjoiMXVLa2lsb3B2RnhsS0FuYUU0bThqUmVjZDdCIiwibiI6IkJUY2hRU2pOVDBSUjc0cHUifQEilR0MPcmh9JdsQ1omPx1cJQvh_RjDwI_AnHAWu-G1YSN9ZTjoKswEhDObUaefE8nf97AlccfogXrvrcjfpE7gDJCz4oI-6rfM43E9T_Or3uyOG3OgHoK9eyUX-qv8WTYwnf1tzwVN1e1D4B0Kr81yQBi2Y-MdeIH60rkOFI42w6I9fEJRDnPRoFqRn2Hw70ehjrCRpkeRKS9emduCL_YNZmjNEst1i6heg5-sqtkBYrYaqWecKJ5rqskQN_apfrX-BEfh6Ph2j7hYKJ6s32j3dOGR9paTFikewtKWMXBcy6kW5uZqGwO05sVW1Wy6HavxpNm5ha50WKotoEndvzuW0RasT9YLbCry1qRYt3X8NKybpERt2u7lRHNSY3DuVtbXbeR9oUzsO1Br31ywH0dBkn3WsfPYFOaEt0htVo0_DlDZh-0oH4PdzvCkzDQn-EM8u9PCxzvxSMGtQ_UXcDxEZcUgfgnLQy4Fu2AHumF136tXZyTh8GAd-mLqC6xtvOXJTDF7s0TxQ7A57d9C1EDrEJOBuq
limit
integer [ 1 .. 25 ]

The maximum numbers of records to return. It accepts an integer ranging from 1 to 25. Otherwise, the request will be rejected.

Example: limit=25
header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

The response body contains a list of integrations.

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Response samples
application/json
{
  • "integrations": [
    ],
  • "next": "dGhpcyB2YWx1ZSBpcyBvcGFxdWUsIGRlY29kaW5nIGl0IHdvbid0IGJlIHVzZWZ1bAo"
}

Describe a specific integration

get/integrations/{integrationID}

Get integration data for a specific Trend Micro Cloud One account. A Trend Micro Cloud One account can have multiple integrations per service.

SecurityCloudOneApiKey
Request
path Parameters
integrationID
required
string^([a-f0-9]){8}-(([a-f0-9]){4}-){3}([a-f0-9]){...

The Trend Micro Cloud One ID for this integration.

Example: ad57fdce-76b2-4745-a0e5-5474c768e42e
header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
200

The response body contains the integration details.

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

404

The resource you were looking for doesn't exist.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Response samples
application/json
{
  • "alias": "ABC-department-integration",
  • "description": "This integration if for the ABC department, managed by John Doe.",
  • "integrationID": "ad57fdce-76b2-4745-a0e5-5474c768e42e",
  • "provider": "github",
  • "state": "managed",
  • "lastModified": "2022-07-19T21:33:00Z"
}

Delete a specific integration

delete/integrations/{integrationID}

Deletes integration data for a specific Trend Micro Cloud One account.

SecurityCloudOneApiKey
Request
path Parameters
integrationID
required
string^([a-f0-9]){8}-(([a-f0-9]){4}-){3}([a-f0-9]){...

The Trend Micro Cloud One ID for this integration.

Example: ad57fdce-76b2-4745-a0e5-5474c768e42e
header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Responses
204

The integration has been deleted

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

404

The resource you were looking for doesn't exist.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Modify a specific integration

post/integrations/{integrationID}

Modify integration data for a specific Trend Micro Cloud One account.

SecurityCloudOneApiKey
Request
path Parameters
integrationID
required
string^([a-f0-9]){8}-(([a-f0-9]){4}-){3}([a-f0-9]){...

The Trend Micro Cloud One ID for this integration.

Example: ad57fdce-76b2-4745-a0e5-5474c768e42e
header Parameters
Api-Version
required
string

The API version used in this request.

Value: "v1"
Request Body schema: application/json
alias
string (Alias) [ 1 .. 64 ] characters ^[\w\-]*$

The custom alias for this integration

description
string (Description) <= 254 characters ^[\w\.,\s\-]*$

The custom description for this integration

Responses
200

The response body contains the integration details.

400

Something about your request didn't quite make sense. The error message should help you figure out what went wrong.

401

Unauthorized

403

You tried to do something that you're not allowed to do. Check your privileges to see what you're actually allowed to do. This could also mean that your token has expired.

404

The resource you were looking for doesn't exist.

429

You have made too many requests too quickly. Check the Retry-After header for an indication of when you might be able to try again.

500

Something has gone terribly wrong. Sorry! The error message may help you figure out what went wrong, but it's unlikely that you'll be able to do anything about it unless you're the server administrator. It's possible that trying again will help, but it's more likely that you're out of luck for the moment.

503

The service is temporarily unavailable, likely due to maintenance. It should be available soon, check the Retry-After header for an indication of when you might be able to try again.

Request samples
application/json
{
  • "alias": "ABC-department-integration",
  • "description": "This integration if for the ABC department, managed by John Doe."
}
Response samples
application/json
{
  • "alias": "ABC-department-integration",
  • "description": "This integration if for the ABC department, managed by John Doe.",
  • "integrationID": "ad57fdce-76b2-4745-a0e5-5474c768e42e",
  • "provider": "github",
  • "state": "managed",
  • "lastModified": "2022-07-19T21:33:00Z"
}