Integrations

Configure many 3rd party services as Integrations and reuse the Integration anywhere with beplus CLI.

GET/rest/integrations

List all Integrations

This endpoint allows you to retrieve a paginated list of all your Integrations.

Filtering

  • Name
    filter.integrationSlug
    Type
    string
    Description

    Human-readable identifier of the Integration.

  • Name
    filter.level
    Type
    number
    Description

    Use when retrieving a specific hierarchy level.

Pagination

  • Name
    pagination.limit
    Type
    integer
    Description

    Limit the number of Integrations returned.
    Default: 10

  • Name
    pagination.token
    Type
    string
    Description

    The token used to retrieve the next page of Integrations.

Returns

Request

GET
/rest/integrations
curl -G https://api.bepluscloud.com/rest/integrations \
  -H "Authorization: Bearer {token}" \
  -H "X-beplus-API-Version: 2023-11-17" \
  -d pagination.limit=5

Response

{
  "$metadata": {
    "httpStatusCode": 200,
    "requestId": "61b1e08e-431e-45ea-8ade-cbf1e63f6182"
  },
  "integrations": [
    {
      "uid": "5830d641-0fa3-42c4-b4a8-e1c3fc814bca",
      "entityType": "INT",
      "ownerSlug": "beplus",
      "integrationSlug": "aws",
      "integrationItem1": "o-abcdef1234",
      "integrationItem2": "111122223333",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "version": "1"
    },
    {
      "id": "dcaa43d4-416b-45f7-a93a-61de1df8880e",
      ...
    }
  ],
  "pagination": {
    "token": null
  }
}
POST/rest/integrations

Create an Integration

This endpoint allows you to create a new Integration.

Required Attributes

  • Name
    integrationSlug
    Type
    string
    Description

    Human-readable identifier for the Integration.

Optional Attributes

  • Name
    integrationItem[1..n]
    Type
    string
    Description

    Create a hieararchy of IntegrationItems.

  • Name
    displayName
    Type
    string
    Description

    The name of the Integration, as shown in the beplus.cloud Console.

  • Name
    avatarUrl
    Type
    string
    Description

    The avatar image URL for the Integration.

Returns

Request

POST
/rest/integrations
curl -X POST https://api.bepluscloud.com/rest/integrations \
  -H "Authorization: Bearer {token}" \
  -H "X-beplus-API-Version: 2023-11-17" \
  -d integrationSlug="aws" \
  -d integrationItem1="o-abcdef1234" \
  -d integrationItem2="111122223333"

Response

{
  "$metadata": {
    "httpStatusCode": 201,
    "requestId": "a6b27d33-677d-48c6-9064-96bc3dd46c18"
  },
  "integration": {
    "uid": "5830d641-0fa3-42c4-b4a8-e1c3fc814bca",
    "entityType": "INT",
    "ownerSlug": "beplus",
    "integrationSlug": "aws",
    "integrationItem1": "o-abcdef1234",
    "integrationItem2": "111122223333",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "version": "1"
  }
}
GET/rest/integrations/:uid

Retrieve an Integration

This endpoint allows you to retrieve an Integration by providing its uid.

Returns

Request

GET
/rest/integrations/:uid
curl -X GET https://api.bepluscloud.com/rest/integrations/5830d641-0fa3-42c4-b4a8-e1c3fc814bca \
  -H "Authorization: Bearer {token}" \
  -H "X-beplus-API-Version: 2023-11-17"

Response

{
  "$metadata": {
    "httpStatusCode": 200,
    "requestId": "fb7eed41-6d23-4a1d-b6b3-3fb5d0fef03b"
  },
  "integration": {
    "uid": "5830d641-0fa3-42c4-b4a8-e1c3fc814bca",
    "entityType": "INT",
    "ownerSlug": "beplus",
    "integrationSlug": "aws",
    "integrationItem1": "o-abcdef1234",
    "integrationItem2": "111122223333",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "version": "1"
  }
}
PUT/rest/integrations/:uid

Update an Integration

This endpoint allows you to perform an update on the Integration.

Currently, the only attributes that can be updated on the Integration are displayName and avatarUrl.

Attributes

  • Name
    displayName
    Type
    string
    Description

    The name of the Integration, as shown in the beplus.cloud Consoleonsole.

  • Name
    avatarUrl
    Type
    string
    Description

    The avatar image URL for the Integration.

Returns

Request

PUT
/rest/integrations/:uid
curl -X PUT https://api.bepluscloud.com/rest/integrations/5830d641-0fa3-42c4-b4a8-e1c3fc814bca \
  -H "Authorization: Bearer {token}" \
  -H "X-beplus-API-Version: 2023-11-17" \
  -d displayName="AWS Account #111122223333"

Response

{
  "$metadata": {
    "httpStatusCode": 200,
    "requestId": "18bc7606-b935-4e46-81fc-5b36be047558"
  },
  "integration": {
    "uid": "5830d641-0fa3-42c4-b4a8-e1c3fc814bca",
    "entityType": "INT",
    "ownerSlug": "beplus",
    "integrationSlug": "aws",
    "integrationItem1": "o-abcdef1234",
    "integrationItem2": "111122223333",
    "displayName": "AWS Account #1111-2222-3333",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-02T00:00:00.000Z",
    "version": "2"
  }
}
DELETE/rest/integrations/:uid

Delete an Integration

This endpoint allows you to delete an Integration.

Returns

Request

DELETE
/rest/integrations/:uid
curl -X DELETE https://api.bepluscloud.com/rest/integrations/5830d641-0fa3-42c4-b4a8-e1c3fc814bca \
  -H "Authorization: Bearer {token}" \
  -H "X-beplus-API-Version: 2023-11-17"

Response

{
  "$metadata": {
    "httpStatusCode": 204,
    "requestId": "e0427e39-3843-4a43-a61f-2bdc46ae86dd"
  }
}