Endpoint
/api/v2/tenants/{tenantId}/customBranding
Path Parameters
tenantId
string

Describes the clientId or mspId of the tenant

applicationTitle
string

domain
string

favIcon
object

favIcon.file
favIcon.name
headerBackgroundColor
string

loginPageBackgroundColor
string

loginPageHeaderText
string

loginPageImage
object

loginPageImage.file
loginPageImage.name
loginPageSubHeaderText
string

loginPageTextColor
string

logo
object

subDomain
string

tabBackgroundColor
string

{
  "applicationTitle": "OpsRamp",
  "domain": "opsramp.net",
  "favIcon": {
    "file": "iVBORw0KG...5ErkJggg==",
    "name": "OpsRamp.png"
  },
  "headerBackgroundColor": "ffffff",
  "loginPageBackgroundColor": "0000ff",
  "loginPageHeaderText": "Control the Chaos",
  "loginPageImage": {
    "file": "/9j/4AAQSkZ...KKV2B//9k=",
    "name": "OpsRamp.png"
  },
  "loginPageSubHeaderText": "Your Digital Operations Command Center awaits.",
  "loginPageTextColor": "ffffff",
  "logo": {
    "file": "iVBORw0KGgo...ORK5CYII=",
    "name": "OpsRamp.png"
  },
  "subDomain": "cloud",
  "tabBackgroundColor": 444444
}
{
  "applicationTitle": "OpsRamp",
  "favIcon": {
    "file": "iVBORw0KGg...U5ErkJggg==",
    "name": "OpsRamp.png"
  },
  "headerBackgroundColor": "ffffff",
  "loginPageBackgroundColor": "0000ff",
  "loginPageHeaderText": "Control the Chaos",
  "loginPageImage": {
    "file": "/9j/4AAQSkZ...flaKKV2B//9k=",
    "name": "OpsRamp.png"
  },
  "loginPageSubHeaderText": "Your Digital Operations Command Center awaits.",
  "loginPageTextColor": "ffffff",
  "logo": {
    "file": "iVBORw0KGgo...UVORK5CYII=",
    "name": "OpsRamp.png"
  },
  "tabBackgroundColor": 444444
}

Responses

OK

apiURL
string

appURL
string

applicationTitle
string

favIcon
object

favIcon.file
favIcon.name
headerBackgroundColor
string

loginPageBackgroundColor
string

loginPageHeaderText
string

loginPageImage
object

loginPageImage.file
loginPageImage.name
loginPageSubHeaderText
string

loginPageTextColor
string

logo
object

tabBackgroundColor
string

{
  "apiURL": "cloud.api.opsramp.net",
  "appURL": "cloud.app.opsramp.net",
  "applicationTitle": "OpsRamp",
  "favIcon\"": {
    "imageType": "image/png\"",
    "logoPath": "https://app.opsramp.com/images//org/favicon/92/165.png?1600154254655",
    "thumbPath": "https://app.opsramp.com/images//org/favicon/92/thumb-165.png?1600154254687",
    "tinyThumbPath": "https://app.opsramp.com/images//org/favicon/92/tiny-thumb-165.png?1600154254707"
  },
  "headerBackgroundColor": "ffffff",
  "loginPageBackgroundColor": "0000ff",
  "loginPageHeaderText": "Control the Chaos",
  "loginPageImage\"": {
    "imageType": "image/png\"",
    "logoPath": "https://app.opsramp.com/images//org/login/92/166.png?1600154254727",
    "thumbPath": "https://app.opsramp.com/images//org/login/92/thumb-166.png?1600154254807",
    "tinyThumbPath": "https://app.opsramp.com/images//org/login/92/tiny-thumb-166.png?1600154254851"
  },
  "loginPageSubHeaderText": "Your Digital Operations Command Center awaits.",
  "loginPageTextColor": "ffffff\"",
  "logo\"": {
    "imageType": "image/png\"",
    "logoPath": "https://app.opsramp.com/images//org/92/164.png?1600154254559",
    "thumbPath": "https://app.opsramp.com/images//org/92/thumb-164.png?1600154254595",
    "tinyThumbPath": "https://app.opsramp.com/images//org/92/tiny-thumb-164.png?1600154254635"
  },
  "tabBackgroundColor": 444444
}
{
  "applicationTitle": "OpsRamp",
  "favIcon": {
    "imageType": "image/png",
    "logoPath": "https://app.opsramp.com/images//org/favicon/69903/165.png?1600154254655",
    "thumbPath": "https://app.opsramp.com/images//org/favicon/69903/thumb-165.png?1600154254687",
    "tinyThumbPath": "https://app.opsramp.com/images//org/favicon/69903/tiny-thumb-165.png?1600154254707"
  },
  "headerBackgroundColor": "ffffff",
  "loginPageBackgroundColor": "0000ff",
  "loginPageHeaderText": "Control the Chaos",
  "loginPageImage": {
    "imageType": "image/png",
    "logoPath": "https://app.opsramp.com/images//org/login/69903/166.png?1600154254727",
    "thumbPath": "https://app.opsramp.com/images//org/login/69903/thumb-166.png?1600154254807",
    "tinyThumbPath": "https://app.opsramp.com/images//org/login/69903/tiny-thumb-166.png?1600154254851"
  },
  "loginPageSubHeaderText": "Your Digital Operations Command Center awaits.",
  "loginPageTextColor": "ffffff",
  "logo": {
    "imageType": "image/png",
    "logoPath": "https://app.opsramp.com/images//org/69903/164.png?1600154254559",
    "thumbPath": "https://app.opsramp.com/images//org/69903/thumb-164.png?1600154254595",
    "tinyThumbPath": "https://app.opsramp.com/images//org/69903/tiny-thumb-164.png?1600154254635"
  },
  "tabBackgroundColor": 444444
}