Harness

Account Banner

This contains APIs for Account Banners.

Retrieves the list of Banners in account scope

Retrieves the list of Banners in account scope

Securityx-api-key
Request
query Parameters
search_term
string

This would be used to filter resources having attributes matching with search term.

page
integer
Default: 0

Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page

limit
integer <= 1000
Default: 20

Number of items to return per page.

sort
string

Parameter on the basis of which sorting is done.

Enum: "name" "identifier" "created" "updated"
order
string

Order on the basis of which sorting is done.

Enum: "ASC" "DESC"
enabled
string

Show banners with enabled field filtering

Enum: "true" "false"
header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Responses
200

Example response

get/v1/banners
Request samples 
Response samples 
application/json
[
  • {
    }
]
Creates a new Banner in account scope
Creates a new Banner in Account Scope.


Securityx-api-key 
Request 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Request Body schema: application/json
name
required
string
 
identifier
required
string
 
enabled
boolean
 Default:  false
 
intent
required
string (BannerIntent) 
enum for "intent" field in BannerDTO


 Enum: "INFORMATIONAL" "HIGH" "MEDIUM" "LOW"  
title
required
string  <= 80 characters 
Banner Title with max length 80


 
message
required
string  <= 250 characters 
Banner Message with max length 250


 
callToActions
object
 
Responses 
201
Example response


post/v1/banners
Request samples 
application/json
{
  • "name": "string",
  • "identifier": "string",
  • "enabled": false,
  • "intent": "INFORMATIONAL",
  • "title": "string",
  • "message": "string",
  • "callToActions": { }
}
Response samples 
application/json
{
  • "banner": {
    },
  • "created": 0,
  • "updated": 0
}
Validate if the specified Banner identifier is available for use in account scope
Validate if the specified BannerDTO identifier is available for use in account scope


Securityx-api-key 
Request 
path Parameters
bannerId
required
string
Identifier field of the BannerDTO


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Responses 
200
This Response body is used in validate banner identifier endpoint & /v1/banners/allowed


get/v1/banners/validate-unique-identifier/{bannerId}
Request samples 
Response samples 
application/json
true
Check for a current account max 5 banners are enabled or not
Check for a current account max 5 banners are enabled or not.


Securityx-api-key 
Request 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Responses 
200
This Response body is used in validate banner identifier endpoint & /v1/banners/allowed


get/v1/banners/allowed
Request samples 
Response samples 
application/json
true
Updates the specified Banner in account scope
Updates the specified Banner in account scope


Securityx-api-key 
Request 
path Parameters
banner
required
string
Identifier field of the Banner


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Request Body schema: application/json
Request body when updating respective Banner.


name
required
string
 
identifier
required
string
 
enabled
boolean
 Default:  false
 
intent
required
string (BannerIntent) 
enum for "intent" field in BannerDTO


 Enum: "INFORMATIONAL" "HIGH" "MEDIUM" "LOW"  
title
required
string  <= 80 characters 
Banner Title with max length 80


 
message
required
string  <= 250 characters 
Banner Message with max length 250


 
callToActions
object
 
Responses 
200
Example response


put/v1/banners/{banner}
Request samples 
application/json
{
  • "name": "string",
  • "identifier": "string",
  • "enabled": false,
  • "intent": "INFORMATIONAL",
  • "title": "string",
  • "message": "string",
  • "callToActions": { }
}
Response samples 
application/json
{
  • "banner": {
    },
  • "created": 0,
  • "updated": 0
}
Deletes the specified Banner in account scope
Deletes the specified Banner in account scope


Securityx-api-key 
Request 
path Parameters
banner
required
string
Identifier field of the Banner


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Responses 
204
No Content


400
delete/v1/banners/{banner}
Request samples 
Response samples 
application/json
{ }
Return Active Banners
This API endpoint will return max 5 banners as that is the enabled banners count.


Securityx-api-key 
Request 
query Parameters
search_term
string
This would be used to filter resources having attributes matching with search term.


 
page
integer
 Default:  0
Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page    


 
limit
integer  <= 1000 
 Default:  20
Number of items to return per page.


 
sort
string
Parameter on the basis of which sorting is done.


 Enum: "name" "identifier" "created" "updated"  
order
string
Order on the basis of which sorting is done.


 Enum: "ASC" "DESC"  
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Responses 
200
Example response


get/v1/banners/active
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to AccountSetting