AIaikido

Add a broker resource URL

Adds an internal resource URL that a broker app can access. Only base URLs are allowed, without a path (for example https://internal.resource.com). Resource URLs that point to another broker resource are not allowed.

post/broker/apps/{broker_app_id}/resource-urls

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/broker/apps/{broker_app_id}/resource-urls
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: broker:write

Path parameters

broker_app_idinteger required

The ID of the broker app to add the resource URL to

Request body

internal_urlstring required

The internal base URL that the broker app should be able to access. Must be a valid URL without a path.

Example request

{
  "internal_url": "https://gitlab.internal.company.com"
}

Response

The resource URL has been added

idinteger

The ID of the newly added resource URL

broker_urlstring

The public broker URL used to reach the internal resource

internal_urlstring

The internal base URL that the broker app can access

Example response

{
  "id": 12,
  "broker_url": "https://123-a1b2c3d4e5.aikidobroker.com",
  "internal_url": "https://gitlab.internal.company.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.