Create Banners via API
complete
L
Likely Turtle
I would like the ability to create banners via the API. This feature would streamline our processes and allow for more efficient management of banners across different accounts.
Log In
A
Abhishek Thamman
complete
A
Abhishek Thamman
Hey Likely Turtle, the APIs are now updated in the API docs: https://apidocs.harness.io/tag/Account-Banner
A
Abhishek Thamman
pending feedback
A
Abhishek Thamman
Hi Likely Turtle, thanks for the request. Creating banners through API is possible today. The API docs: https://apidocs.harness.io/ are getting updated and you should see the banners related API there in a week or two. Meanwhile, I am sharing the curl requests that can help you get unblocked.
To use Custom Banners via API, first ensure that FF PL_CUSTOM_BANNERS is enabled in your account.
Replace <API_KEY> with your PAT & {accountId} with your account identifier for the following curls.
Example request payload body:
{
"name": "testBanner123",
"identifier": "testBanner123",
"title": "title",
"message": "message",
"intent": "HIGH", // can be either of the values ~ 'HIGH' | 'INFORMATIONAL' | 'LOW' | 'MEDIUM'
"enabled": true, // this is to enable the banner on save, not passing this will default
enabled
key to false."callToActions": {
"Learn More": "https://harness.io"
} // can have maximum 2 call to actions key value pair in the "callToActions" object (optional)
}
Create a banner which is enabled on create using Example Request Payload:
-H 'accept:
/
' \-H 'content-type: application/json' \
-H 'harness-account: {accountId}' \
-H 'x-api-key: <API_KEY>' \
--data-raw '{"name":"testBanner123","identifier":"testBanner123","title":"title","message":"message","intent":"HIGH","enabled":true,"callToActions":{"Learn More":"https://harness.io"}}'
Delete a banner:
-X 'DELETE' \
-H 'harness-account: {accountId}' \
-H 'content-type: application/json' \
-H 'x-api-key: <API_KEY>'
Edit a banner:
update the json string of --data-raw, Take help of Example Request Payload attached above for reference (NOTE: identifier in the path and body should be same)
-X 'PUT' \
-H 'harness-account: {accountId}' \
-H 'content-type: application/json' \
-H 'x-api-key: <API_KEY>'
--data-raw '{"name":"testtt","identifier":"testtt","enabled":true,"intent":"INFORMATIONAL","title":"fdfdg","message":"dfgdf","callToActions":{}}'
Get Active Banners:
-H 'accept:
/
' \-H 'content-type: application/json' \
-H 'harness-account: {accountId}' \
-H 'x-api-key: <API_KEY>'