Subscribe to BFDP pipeline.

POST

/api/ai_data/bfdp/namespaces/system/bfdp/subscribe

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/ai_data/bfdp/namespaces/system/bfdp/subscribe \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "product_name": "example" }'

• F5 Distributed Cloud Console

Subscribe to BFDP pipeline.

Examples of this operation.

Authorizations

• ApiToken

Request Body^required

Media typeapplication/json

SubscribeRequest

Request to subscribe to BFDP CMS.

object

product_name

product_name

F5 product’s pipeline object name .

string

<= 1024 characters

Example^generated

{
  "product_name": "example"
}

Responses

200

A successful response.

Media typeapplication/json

SubscribeResponse

Response of subscribe to BFDP CMS.

object

configured_tenant_id

configured_tenant_id

F5 product’s pipeline configured tenant .

string

<= 1024 characters

pipeline_id

pipleine_id

F5 product’s pipeline ID for which this tenant is configured.

string

<= 1024 characters

pipeline_name

pipeline_name

F5 product’s pipeline name for which this tenant is configured.

string

<= 1024 characters

token

token

F5 product’s pipeline token to ingest data .

string

<= 1024 characters

Example^generated

{
  "configured_tenant_id": "example",
  "pipeline_id": "example",
  "pipeline_name": "example",
  "token": "example"
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example