Skip to content

Retrieve your organization's settings

Request

Security
x-api-key
curl -i -X GET \
  https://eu1.api.pushsecurity.com/v1/settings \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Headers
any
Bodyapplication/json
monitoredDomainsArray of stringsrequired

The domains that are monitored as belonging to your organization.

Example:
[ "example.com", "example.org" ]
monitorAllDomainsbooleanrequired

Whether all domains (not just monitoredDomains) are monitored.

Example:true
brandingobject(Extension branding)required

Branding shown on Push banners and block pages.

Response
{ "monitoredDomains": [ "example.com", "example.org" ], "monitorAllDomains": true, "branding": { "logoId": "f3133cea-bc0b-45c8-95a1-7320360ef847", "borderColor": "#EE4323", "buttonColor": "#FF9D29", "linkColor": "#02B0E6", "helpLinkHidden": false, "helpLinkText": "Why am I seeing this?", "helpLinkUrl": "https://pushsecurity.com/help/audience/employees/docs/what-is-push/", "alignment": "CENTRE", "theme": "DARK" } }