---
id: ping-cluster
sidebar_label: Ping cluster for source connector
hide_title: true
hide_table_of_contents: true
api: eJztW1tz2zYW/isY7kOTjKmbZTvSy45iO7vu+FbL3jw4mS1EQhIaCmB5iaN6/N/3OwcQRVlykqadbZNRHhyJBA7O/XwHAu4Dm6pMFtqakzjoB6k2k8OkzAuVBTtBISd50L8NhrbMIpUH73aCWOVRplOagOHXU50LZeLUalOIDzLRsSxULoqpLPBHicjREiMFwqLMVSxGc36TM02B+ZmS0VSOEiXGmZ2Jk1iZQhfzc3vXeGsGorDvlRF3upiKi6t//XdwdHZyLmRZTG2GUY7Ar6XOQLqwIpJJAvp4Org8aUCGXEUlDYQc98FNrrJDawr1sRiAAsmmY9N3vISRNUZFhc36M2nkRAXvHiBxKjM5UxAiZxKa5E4lJu8EBi/wzU2H/rBaNFUzGfTvg2Ke8rsig+TBw06w4DLoF1mp1jWpxMmRsGNWjlM46KmPcpYmRChS412lOq12POp1D6K9Xruzt9dutfdGshXtH/QC4jVTeWpNDlOBg06rRf+tr4NRZVLQWmRuMoyXHEOcomsGqpRCyoxId6YgsjJNEx2x5zR/yYn2/br0dvQL5pIn6YKlGBayKHNx5fkMHqth8ULMbKwSMbZZnTeQj97v0JOxnpTObQX8rRDSxCwMCfWY8Zw4TzNy9EI71eh43USPWVlaI1+3RifqtV+2Xu7tv4z2Or1ov9XGp0juj3utqL3b3g3IFjK+MMnc2fth4S2fW/Ycoz6x8MXRMBwchdck9K332x7/e7dpzZz1vWlVZcoZx/bN4eHxcIgnrwcnpzdXx5uiHKw4w3nGpkomcBO2R2OFvyW5NV5UIlMkgDOdJLrOElKHmnC+WV8WTI6QPrDsjKcpWDXORZ7CCwUZH2MoXWSKswC0ssJOu9VqbeAkVoXUSb7JUddZiG1Uzmg5cn6pTc6LuhjarJC3hjXGweAGIB1VZGIF5iGD554YqHktpUgQWNNfTaj7AIOuT4evbXby01BlHzR8pD+WSY5RtSf3AQaJS5shXqGFxvnxtTg8vRL/QSpz4nUbrcZua7fda3SRLFpYdMgKltncUxl6/wmuSmOc4ziCe6090Py3zfE5GNxcX5wNrk8uzuGbGHLu8uKSlxpfGyg+XrQ+NTwxcD0TqXZYDcOUpQzVSDFUadhpdVou6buhFbPtneBiKAZZNNUFLF1mtMrg7Gi/i+EXrgYifQznKFeIi+BMR5nN7bgQb7SJ7V0uaBm4IjJwR1x1BOSgFSjpT/VkCs87ssW5KurafSmQvxLpiumrUiexuNasmlav2ek0iVvR2u/vdsXgTIRQaYsqRSXSYaLhMVSpjg0VyLgys3f2y8yiLsNlLmjBdrPdI5pt0e53D/rtrrg8Cx7cv52gu6kcuBXEcZaB0xB5GZoxqKR67L2clxEjG3Ol1YZr/B8qBauZ2IXiIbL951Pja21UOMkQg+BQMcsRJgpQ/KBjMt/MIhE4kovI5HGrOQqaaLTFKxlDXiffoRcGaioyGb0HrZMvKBE3RmO+WEwROuaK9cSy6kDJ0X6r1+mO97tSdl522wd7o95Y7u62enu9Hq0+gzWBPOqpSWaZnK8t/S9lVKYjkVggHv0bFIJ8Ad0zA7w4psDVZxuz3KoNmMYX6J+ymhtbien5FYSodoQUrw4vRfcAPm8mJT+Xk0dKMOENVQdTJgm5dJWTHeGLTE+0+VS9Ojp+Pbg5vcaTq+Ofbo6H+ES01orWwMBbY3JLy/Vjau+YYy/AnUQVUQnUgXwrXniqLyCQ9BneD9TuW86JAb41lsj7mOFX3zCjTtpB2nooRQ5+ime6oRo7AMZ4NpNFNBUjSfDYl4UXgyhSaRGeek2+oBITq+x5QwziWJOQMiHEDaKYPwchIeOYQtcRGJeU5BjO2bIQxhZIKKu2WKpy1RpLuHZaNwoFBzj/vJ8MkF/BHItZj8LKWzyL3j7g2WlulbvrmtJYpXOUX+BAQvhzqDHLoGExgmwaddinIzJXjsRjFuOqjEUpcCEWp7szx8xRYfldJMv8C+LuMkH6CVm06sUH5YMvpw7EZSO2xsJMPiPhJVd8muxHVeZaBL4Ya5XE29jdxu42dr8wdh+/XPSQ/i1Dn/Y69LkxfhOBiuca9MnYe4xd7DT85ppNZ8gdwnUeIv345tpvUdBWyMeUWvw/ER+5Ur7G/KCyh3s+IvhRGWvFFsSg35khCcbIRCruM99LjoMlStxdXw2dxkjDQc0GiIismYm5LYWkHsxheiHzHTQ8Kjc/FGIqkR9lRDjVZUC3ZRTyntEWSW6R5LYabavR91ONtkhyG7vb2P02Y/eTSLLiiqPF46S8nM1oR5I9zb8naaXAALH4OUZUIcemeoxWiJioMFawihyCUac9ao8PItWNZTfe3+2NO9F+R+4dtA/ao27nIKjX+ttlHFdBthpTNXs7O7rtfbe5WRo4V15YG69u/0G9mRpTWqPUU+Fm6BwqfbfEjt117HhuC8gGwsCO2RPbizdXp0QfSzN50pvbDaegZdW5XxQJUpIPQ9M6L7bQcQsdt+VnW36+m/KzhY7b2N3G7rcZu78LOnY/Bx27vwM6dgVBrDFBrL8SOsbAHQTNxjAKZIhKqNcQbEwhCj753Ucf9oXMJqqogN4Kiuz0NhxbslacSTNfgKV8ZSfSLNVF6Q1jZzQ2W4zFACkmSJFGIGtpoFvyKj1ThEnhPyLRM81xTAKBbjYPB2M6t+ZiZuFv1SraREkJDjkpJJb2Xi18TMOd1JjgHyjwPugEifpP3OP01vpD+8HiiiQ+JYnF8cdIKYr5av93b9MpgRMwn1G68Gcgnjgu4PbMpUEboT6mLn1VEHQL1bdQfVvut+X++yj3W6i+jd1t7H6bsfs7oLpHQ09DdQz4YqiOsY2WqLDUa3Ku/zti51DxHLB7CxsxVo+XGJxxBVyJL4RY3mjlCw/9oOnget68X9x5eGhW5+ybdAA/jKrbI64xcHyWWYLp06JI836zeQ/zwWwPDZnqhvb3PYy9a0R21hxBZxvSEZ0+daFHA+h2h+88GqzwTJNPuwTIxJ36WUTyXpiBDxx8krLxZ+/nEE44Mjt0QNv7Fz8Giymaix9yHt1gf1qTD3LdZMnDH5fFEXpClk3q++RqGC/A6SMRSYR3y4syQ0LibvW16zLL6kK/AXTWFrugYR3xSskMbYI7FvPsxzfXz8WE8CfHf5kT9FWaGgZE0CVchPPbYHFEhCZxyclsOXF3UQYrh3AonsQ4gcDirRkqJW5rd4bEFTI1q5QmKU4ONOvds4V1YvVBJVQTG0tNkuPp2DShoaZcmfec6x83Ctrg44yfNt6aUBzpzF1MyXmMF5H7PnGbLuSSNbm+lol/LKiFjlrI1PLnj7hwqr2N3KHuCEFNJGSSs7a+enFHL6zRo64KT4jqYx5IE56P1aNT0cJqX83HCr2Q6K3y8da8mWoU19VpwuUykaM2JrE4EdHU2lz9UwhyHQqD20mJKPpqtu5o0ZAjIuy0aiyFbslQh4CKzN8pAsM4Z5IjKtWMVKzbNOGQ/Jkti5j/me80/bwiMz++RUWlkbGN8q/mmRYMacHQ5YDc8+9vxjznGygkA+cB5wCHS/tzJvCM1vKeo7UxqzP5Js+h0hCBVaaSp333pb9McP6T4Bc0uhqDNExIuzpMRpf9PC2qWivKWuwRPNbgOr+JRbF8pDfHb/VLJxXQv5u8JPFguZVCd4X+7Cz9RCb5++TdvyjjbTPN95hpPPYld+NlfZNQd/JXHq+tb+3R3vNU4S/ecqwyzEYTs7xRWyeUJrIgr+aojqZa8aZAqmRB2G+HPMvOOBJTf8crd4QmmaILZWBZoo3TCejxtvViZckB44Al2ZW+56U/RGHhkmgyVUO8oXuTEcxCPRod38W7X6xv1oawzCVf6T5aGBugazYrDd24BtvlTEi41Gc8ItZ5VLrE5ZsEJ4Jl6FfNWkQxuRqJ0OBuJZvlF+PlhcAvXAt2z/1mM1RPVvR3tJeCXKmEPZPGrcL2z9GGt4VTlaTUJSLrKrrAvFzh7OR6jSKIGf8Lh80mTT8pb9JYEPlQ3RXcbbQbrZDbBTynpgt9bY34pcvG7jI9JcbHl5wfO+T9csP9W7il7wsWdRrNlLbMSA2l63xc73nrr9mT2fq1G/d1Daw0oGhppnw99Ta4v6f9FurIHujxr6WiZv723bLZ4iYVdl69ZfmkRp9deWGe8y9GGy7ubxRosVNo5stNggAf3yvaW6iEQh8O3nkLiPlyr90mUW3i2s8o1MVVjfvlBW2XMfrZhAj8BygBOe9/0c/9cg==
sidebar_class_name: "post api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Ping cluster for source connector' (ping-cluster)"
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Ping cluster for source connector</h1>

<MethodEndpoint method={"post"} path={"/sources/{sourceId}/connector/ping-cluster"}></MethodEndpoint>



This endpoint validates that the cluster being used by the source is reachable from IdentityNow.
A token with ORG_ADMIN authority is required to call this API.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"description":"The ID of the Source","example":"cef3ee201db947c5912551015ba0c679"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

The result of pinging connection with the source connector.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the source","example":"ODS-AD-Test [source-999999]","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SUCCESS`, `FAILURE`]"} schema={{"type":"string","enum":["SUCCESS","FAILURE"],"description":"The status of the health check.","example":"SUCCESS","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"elapsedMillis"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of milliseconds spent on the entire request.","example":1000,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"details"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"The document contains the results of the health check.\nThe schema of this document depends on the type of source used.\n","readOnly":true,"example":{"useTLSForIQService":false,"IQService":{"TLS Port":0,".NET CLR Version":"4.0.30319.42000","SecondaryServiceStatus":"Running","Port":5050,"Host":"AUTOMATION-AD","Name":"IQService","IQServiceStatus":"Running","SecondaryService":"IQService-Instance1-Secondary","Version":"IQService Sep-2020","secondaryPort":5051,"OS Architecture":"AMD64","Operating System":"Microsoft Windows Server 2012 R2 Standard","highestDotNetVersion":"4.8 or later","Build Time":"09/22/2020 06:34 AM -0500"},"IQServiceClientAuthEnabled":false,"requestProcessedOn":"1/19/2021 1:47:14 PM"}}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"2c91808568c529c60168cca6f90c1313\",\n  \"name\": \"ODS-AD-Test [source-999999]\",\n  \"status\": \"SUCCESS\",\n  \"elapsedMillis\": 1000,\n  \"details\": {\n    \"useTLSForIQService\": false,\n    \"IQService\": {\n      \"TLS Port\": 0,\n      \".NET CLR Version\": \"4.0.30319.42000\",\n      \"SecondaryServiceStatus\": \"Running\",\n      \"Port\": 5050,\n      \"Host\": \"AUTOMATION-AD\",\n      \"Name\": \"IQService\",\n      \"IQServiceStatus\": \"Running\",\n      \"SecondaryService\": \"IQService-Instance1-Secondary\",\n      \"Version\": \"IQService Sep-2020\",\n      \"secondaryPort\": 5051,\n      \"OS Architecture\": \"AMD64\",\n      \"Operating System\": \"Microsoft Windows Server 2012 R2 Standard\",\n      \"highestDotNetVersion\": \"4.8 or later\",\n      \"Build Time\": \"09/22/2020 06:34 AM -0500\"\n    },\n    \"IQServiceClientAuthEnabled\": false,\n    \"requestProcessedOn\": \"1/19/2021 1:47:14 PM\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Client Error - Returned if the request body is invalid.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"403 Forbidden\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server understood the request but refuses to authorize it.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not Found - returned if the request URL refers to a resource or object that does not exist

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"404 Not found\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server did not find a current representation for the target resource.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal Server Error - Returned if there is an unexpected error.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"500.0 Internal Fault\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"An internal fault occurred.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>