Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Gorelo Documentation","colors":{"primary":"#1DAF94","light":"#8AEFDD","dark":"#1DAF94"},"logo":{"light":"https://mintcdn.com/gorelo/J8h_fLstMj_tYUTJ/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=J8h_fLstMj_tYUTJ\u0026q=85\u0026s=3c12ffa7afbcef131d2c6fb36f00e159","dark":"https://mintcdn.com/gorelo/J8h_fLstMj_tYUTJ/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=J8h_fLstMj_tYUTJ\u0026q=85\u0026s=2dc592c604dd68bb156e97c047088df2"},"favicon":"https://mintcdn.com/gorelo/eK-NlDv-DeG3Jk2m/favicon.svg?fit=max\u0026auto=format\u0026n=eK-NlDv-DeG3Jk2m\u0026q=85\u0026s=99510712391acd38a7057cf358869244","api":{"url":"full"},"appearance":{"default":"dark"},"background":{"color":{"light":"#FBFBFB","dark":"#1F2023"}},"navbar":{"links":[{"href":"https://feedback.gorelo.io/changelog","label":"Changelog"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.mintlify.com"}},"footer":{"socials":{"x":"https://twitter.com/Goreloio","facebook":"https://www.facebook.com/gorelo.io","linkedin":"https://www.linkedin.com/company/gorelo","youtube":"https://www.youtube.com/@gorelotech","discord":"https://discord.com/invite/BpmP8BSrj6","website":"https://www.gorelo.io/"}},"seo":{"indexing":"navigable"},"fonts":{"family":"Inter","weight":400},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"what-is-gorelo"},{"language":"ar","href":"ar/what-is-gorelo"},{"language":"pt-BR","href":"pt-BR/what-is-gorelo"},{"language":"fr-CA","href":"fr-CA/what-is-gorelo"},{"language":"ca","href":"ca/what-is-gorelo"},{"language":"cn","href":"cn/what-is-gorelo"},{"language":"zh","href":"zh/what-is-gorelo"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gorelo","hasAudioNarration":false,"actualSubdomain":"gorelo","customDomains":["help.gorelo.io"],"gitSource":{"type":"github","owner":"gorelo","repo":"gorelo_public_docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae361329ee4546ca4eb47b6","collectionId":"8ee7ab0f-1eb6-4083-8830-aafa475136bf","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae361329ee4546ca4eb47b6"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae361329ee4546ca4eb47b6","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"en","tag":"API","count":174},{"language":"ar","tag":"API","count":174},{"language":"ca","tag":"API","count":174},{"language":"cn","tag":"API","count":174},{"language":"fr-CA","tag":"API","count":174},{"language":"pt-BR","tag":"API","count":174},{"language":"zh","tag":"API","count":174},{"language":"en","tag":"API reference","count":171},{"language":"ar","tag":"مرجع API","count":171},{"language":"ca","tag":"Referència de l'API","count":171},{"language":"cn","tag":"API 参考","count":171},{"language":"fr-CA","tag":"Référence de l'API","count":171},{"language":"pt-BR","tag":"Referência da API","count":171},{"language":"zh","tag":"API 參考","count":171},{"language":"en","tag":"Billing","count":46},{"language":"en","tag":"Service Delivery","count":40},{"language":"ar","tag":"تقديم الخدمة","count":40},{"language":"ca","tag":"Prestació de servei","count":40},{"language":"cn","tag":"服务交付","count":40},{"language":"fr-CA","tag":"Prestation de services","count":40},{"language":"pt-BR","tag":"Entrega de serviços","count":40},{"language":"zh","tag":"服務交付","count":40},{"language":"ar","tag":"Billing","count":36},{"language":"ca","tag":"Billing","count":36},{"language":"cn","tag":"Billing","count":36},{"language":"fr-CA","tag":"Billing","count":36},{"language":"pt-BR","tag":"Billing","count":36},{"language":"zh","tag":"Billing","count":36},{"language":"en","tag":"Remote Management","count":35},{"language":"ar","tag":"الإدارة عن بُعد","count":35},{"language":"ca","tag":"Gestió remota","count":35},{"language":"cn","tag":"远程管理","count":35},{"language":"fr-CA","tag":"Gestion à distance","count":35},{"language":"pt-BR","tag":"Gerenciamento remoto","count":35},{"language":"zh","tag":"遠端管理","count":35},{"language":"en","tag":"Projects","count":34},{"language":"en","tag":"Assets","count":34},{"language":"ar","tag":"Projects","count":31},{"language":"ca","tag":"Projects","count":31},{"language":"cn","tag":"Projects","count":31},{"language":"fr-CA","tag":"Projects","count":31},{"language":"pt-BR","tag":"Projects","count":31},{"language":"zh","tag":"Projects","count":31},{"language":"ar","tag":"Assets","count":30},{"language":"ca","tag":"Assets","count":30},{"language":"cn","tag":"Assets","count":30},{"language":"fr-CA","tag":"Assets","count":30},{"language":"pt-BR","tag":"Assets","count":30},{"language":"zh","tag":"Assets","count":30},{"language":"en","tag":"Tickets","count":25},{"language":"pt-BR","tag":"Tickets","count":25},{"language":"en","tag":"How-to guides","count":19},{"language":"en","tag":"Documents","count":19},{"language":"ar","tag":"أدلة الكيفية","count":19},{"language":"ar","tag":"Tickets","count":19},{"language":"ca","tag":"Guies pràctiques","count":19},{"language":"ca","tag":"Documents","count":19},{"language":"ca","tag":"Tickets","count":19},{"language":"cn","tag":"操作指南","count":19},{"language":"cn","tag":"Tickets","count":19},{"language":"fr-CA","tag":"Guides pratiques","count":19},{"language":"fr-CA","tag":"Documents","count":19},{"language":"fr-CA","tag":"Tickets","count":19},{"language":"pt-BR","tag":"Guias práticos","count":19},{"language":"zh","tag":"操作指南","count":19},{"language":"zh","tag":"Tickets","count":19},{"language":"ar","tag":"Documents","count":16},{"language":"cn","tag":"Documents","count":16},{"language":"pt-BR","tag":"Documents","count":16},{"language":"zh","tag":"Documents","count":16}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"help@gorelo.io","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"fr-ca/api-reference/alerts/gets-a-single-alert-by-id","slug":"/fr-ca/api-reference/alerts/gets-a-single-alert-by-id","pageMetadata":{"title":"Gets a single alert by id.","description":"Returns the same fields as an item of `GET /v1/alerts`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/alerts/{alertId}","href":"/fr-ca/api-reference/alerts/gets-a-single-alert-by-id","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns the same fields as an item of \", _jsx(_components.code, {\n children: \"GET /v1/alerts\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Gets a single alert by id.","description":"Returns the same fields as an item of `GET /v1/alerts`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/alerts/{alertId}","href":"/fr-ca/api-reference/alerts/gets-a-single-alert-by-id","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Alerts"],"summary":"Gets a single alert by id.","description":"Returns the same fields as an item of `GET /v1/alerts`.","operationId":"get_v1_alerts_alertId","parameters":["a4ec677e-5964-4d08-a5e6-cc3b0d4dd2f8"],"responses":{"200":"cbd81f7b-f01c-442d-aa47-e80ea49ace01","401":"6196b255-c052-4e2c-bb62-4c2a8900b59c","404":"14cae6e6-b376-4340-b4db-8cfd5de6f711","500":"88e9dc52-11cd-4a62-90c2-22fab662e5e1"},"method":"get","type":"path","servers":["b46ffe4c-4a54-4e1e-a59b-94a3878c23e4","31fc67d7-965e-4c8a-946c-9895ebae16df"],"security":["7b6acf03-bfa6-4539-9826-c3ecbd3f6d24"],"path":"/v1/alerts/{alertId}","baseUrlOptions":["https://api.usw.gorelo.io","https://api.aue.gorelo.io"],"title":"Gets a single alert by id.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","urlDisplay":"full"},"dependencies":{"parameters":{"a4ec677e-5964-4d08-a5e6-cc3b0d4dd2f8":{"name":"alertId","in":"path","description":"Alert identifier, the `Id` from `GET /v1/alerts`.","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Alert identifier, the `Id` from `GET /v1/alerts`.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"cbd81f7b-f01c-442d-aa47-e80ea49ace01":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"type":"object","properties":{"Id":{"type":"string","description":"Alert identifier.","format":"uuid","uniqueKey":"Data.Id","typeLabel":"string\u003cuuid>"},"Title":{"type":"string","description":"The alert's subject, as the app's alert list shows it after the type - e.g.\r\n`\"Safari not found\"` for a Process alert, `\"Sentinel Agent Missing\"` for an\r\nAntivirus one, `\"Expires in 10 days\"` for an expiration.","uniqueKey":"Data.Title","typeLabel":"string"},"Type":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Type.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Type.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Type","typeLabel":"object"},"Severity":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Severity.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Severity.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Severity","typeLabel":"object"},"Status":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Status.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Status.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Status","typeLabel":"object"},"Message":{"type":"string","description":"The alert's message. Empty for uptime and external alerts.","uniqueKey":"Data.Message","typeLabel":"string"},"ClientId":{"oneOf":[{"type":"integer","description":"Identifier of the client the alert relates to. Null when the alert's type does not\r\ncarry a client (uptime, external and script alerts).","format":"int64","uniqueKey":"Data.ClientId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the client the alert relates to. Null when the alert's type does not\r\ncarry a client (uptime, external and script alerts).","format":"int64","uniqueKey":"Data.ClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ClientId","typeLabel":"integer\u003cint64> | null"},"AgentAssetId":{"oneOf":[{"type":"string","description":"Identifier of the agent asset the alert relates to - the id `GET /v1/assets/agents/{agentAssetId}`\r\ntakes. Null when there is none, and on an alert about a custom asset or an uptime.","format":"uuid","uniqueKey":"Data.AgentAssetId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Identifier of the agent asset the alert relates to - the id `GET /v1/assets/agents/{agentAssetId}`\r\ntakes. Null when there is none, and on an alert about a custom asset or an uptime.","format":"uuid","uniqueKey":"Data.AgentAssetId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.AgentAssetId","typeLabel":"string\u003cuuid> | null"},"DeviceId":{"oneOf":[{"type":"string","description":"Identifier of the agent asset the alert relates to. \u003cb>Deprecated:\u003c/b> use `AgentAssetId`,\r\nwhich has the same value.","format":"uuid","deprecated":true,"uniqueKey":"Data.DeviceId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Identifier of the agent asset the alert relates to. \u003cb>Deprecated:\u003c/b> use `AgentAssetId`,\r\nwhich has the same value.","format":"uuid","deprecated":true,"uniqueKey":"Data.DeviceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.DeviceId","typeLabel":"string\u003cuuid> | null"},"CustomAssetId":{"oneOf":[{"type":"string","description":"Identifier of the custom asset the alert relates to - the id `GET /v1/assets/custom/{customAssetId}`\r\ntakes. Set on a `Warranty Expiration` alert about a custom asset and on an `API` alert posted with a\r\n`CustomAssetId`; null on every other alert.","format":"uuid","uniqueKey":"Data.CustomAssetId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Identifier of the custom asset the alert relates to - the id `GET /v1/assets/custom/{customAssetId}`\r\ntakes. Set on a `Warranty Expiration` alert about a custom asset and on an `API` alert posted with a\r\n`CustomAssetId`; null on every other alert.","format":"uuid","uniqueKey":"Data.CustomAssetId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.CustomAssetId","typeLabel":"string\u003cuuid> | null"},"CheckId":{"oneOf":[{"type":"string","description":"The check that raised this alert - a reusable check definition applied to devices\r\nthrough a policy, not a per-device record. Null on alerts not raised by one, including\r\nuptime alerts, which carry `UptimeId` instead.","uniqueKey":"Data.CheckId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The check that raised this alert - a reusable check definition applied to devices\r\nthrough a policy, not a per-device record. Null on alerts not raised by one, including\r\nuptime alerts, which carry `UptimeId` instead.","uniqueKey":"Data.CheckId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.CheckId","typeLabel":"string | null"},"UptimeId":{"oneOf":[{"type":"string","description":"The uptime that raised this alert, for `Uptime` alerts only - the same\r\nidentifier `GET /v1/uptime/{uptimeId}` takes. At most one of this and\r\n`CheckId` is set.","format":"uuid","uniqueKey":"Data.UptimeId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The uptime that raised this alert, for `Uptime` alerts only - the same\r\nidentifier `GET /v1/uptime/{uptimeId}` takes. At most one of this and\r\n`CheckId` is set.","format":"uuid","uniqueKey":"Data.UptimeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UptimeId","typeLabel":"string\u003cuuid> | null"},"UptimeCheckId":{"oneOf":[{"type":"string","description":"The uptime that raised this alert. \u003cb>Deprecated:\u003c/b> use `UptimeId`, which has the same value.","format":"uuid","deprecated":true,"uniqueKey":"Data.UptimeCheckId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The uptime that raised this alert. \u003cb>Deprecated:\u003c/b> use `UptimeId`, which has the same value.","format":"uuid","deprecated":true,"uniqueKey":"Data.UptimeCheckId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UptimeCheckId","typeLabel":"string\u003cuuid> | null"},"TicketId":{"oneOf":[{"type":"string","description":"Identifier of the ticket created from this alert. Null when no ticket has been created.","format":"uuid","uniqueKey":"Data.TicketId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Identifier of the ticket created from this alert. Null when no ticket has been created.","format":"uuid","uniqueKey":"Data.TicketId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.TicketId","typeLabel":"string\u003cuuid> | null"},"ContractId":{"oneOf":[{"type":"integer","description":"The contract behind a `Contract Expiration` alert. Null on every other alert.\r\n \r\n\n\r\nThe identifier `GET /v1/contracts/{contractId}` takes, so an expiration alert resolves\r\nto its contract without a second lookup.\r\n","format":"int64","uniqueKey":"Data.ContractId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"The contract behind a `Contract Expiration` alert. Null on every other alert.\r\n \r\n\n\r\nThe identifier `GET /v1/contracts/{contractId}` takes, so an expiration alert resolves\r\nto its contract without a second lookup.\r\n","format":"int64","uniqueKey":"Data.ContractId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ContractId","typeLabel":"integer\u003cint64> | null"},"DomainId":{"oneOf":[{"type":"integer","description":"The web domain behind a `Domain Expiration` alert. Null on every other alert.\r\n \r\n\n\r\nIdentifies the expiring domain, so it distinguishes - and lets a caller group - the many\r\nalerts a single domain produces as its expiry approaches.\r\n","format":"int64","uniqueKey":"Data.DomainId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"The web domain behind a `Domain Expiration` alert. Null on every other alert.\r\n \r\n\n\r\nIdentifies the expiring domain, so it distinguishes - and lets a caller group - the many\r\nalerts a single domain produces as its expiry approaches.\r\n","format":"int64","uniqueKey":"Data.DomainId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.DomainId","typeLabel":"integer\u003cint64> | null"},"DismissedOn":{"oneOf":[{"type":"string","description":"When the alert was dismissed (UTC), or null when it is not dismissed. The same value the\r\napp shows under \"Dismiss - By/On\".","format":"date-time","uniqueKey":"Data.DismissedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the alert was dismissed (UTC), or null when it is not dismissed. The same value the\r\napp shows under \"Dismiss - By/On\".","format":"date-time","uniqueKey":"Data.DismissedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.DismissedOn","typeLabel":"string\u003cdate-time> | null"},"DismissedBy":{"oneOf":[{"type":"integer","description":"Identifier of the technician who dismissed the alert, or null when it is not dismissed.\r\nResolve it with the technician endpoint.\r\n \r\n\n\r\nAlso null when the alert was dismissed automatically rather than by a person, so an\r\nauto-dismissal cannot currently be told apart from an unattributed one.\r\n","format":"int64","uniqueKey":"Data.DismissedBy.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the technician who dismissed the alert, or null when it is not dismissed.\r\nResolve it with the technician endpoint.\r\n \r\n\n\r\nAlso null when the alert was dismissed automatically rather than by a person, so an\r\nauto-dismissal cannot currently be told apart from an unattributed one.\r\n","format":"int64","uniqueKey":"Data.DismissedBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.DismissedBy","typeLabel":"integer\u003cint64> | null"},"CreatedOn":{"type":"string","description":"When the alert was raised (UTC).","format":"date-time","uniqueKey":"Data.CreatedOn","typeLabel":"string\u003cdate-time>"},"UpdatedOn":{"oneOf":[{"type":"string","description":"When the alert was last updated (UTC).","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the alert was last updated (UTC).","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UpdatedOn","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"An alert as returned by the alert list endpoint. All timestamps are UTC.","uniqueKey":"Data","typeLabel":"object"},"DataContext":{"oneOf":[{"type":"object","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext","typeLabel":"object | null"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":{"Id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Title":"\u003cstring>","Type":{"Id":1,"Name":"\u003cstring>"},"Severity":{"Id":1,"Name":"\u003cstring>"},"Status":{"Id":1,"Name":"\u003cstring>"},"Message":"\u003cstring>","ClientId":123,"AgentAssetId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","DeviceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","CustomAssetId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","CheckId":"\u003cstring>","UptimeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","UptimeCheckId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","TicketId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","ContractId":123,"DomainId":123,"DismissedOn":"2023-11-07T05:31:56Z","DismissedBy":123,"CreatedOn":"2023-11-07T05:31:56Z","UpdatedOn":"2023-11-07T05:31:56Z"},"DataContext":null,"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"type":"object","properties":{"Id":{"type":"string","description":"Alert identifier.","format":"uuid","uniqueKey":"Data.Id","typeLabel":"string\u003cuuid>"},"Title":{"type":"string","description":"The alert's subject, as the app's alert list shows it after the type - e.g.\r\n`\"Safari not found\"` for a Process alert, `\"Sentinel Agent Missing\"` for an\r\nAntivirus one, `\"Expires in 10 days\"` for an expiration.","uniqueKey":"Data.Title","typeLabel":"string"},"Type":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Type.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Type.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Type","typeLabel":"object"},"Severity":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Severity.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Severity.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Severity","typeLabel":"object"},"Status":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Status.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Status.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Status","typeLabel":"object"},"Message":{"type":"string","description":"The alert's message. Empty for uptime and external alerts.","uniqueKey":"Data.Message","typeLabel":"string"},"ClientId":{"oneOf":[{"type":"integer","description":"Identifier of the client the alert relates to. Null when the alert's type does not\r\ncarry a client (uptime, external and script alerts).","format":"int64","uniqueKey":"Data.ClientId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the client the alert relates to. Null when the alert's type does not\r\ncarry a client (uptime, external and script alerts).","format":"int64","uniqueKey":"Data.ClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ClientId","typeLabel":"integer\u003cint64> | null"},"AgentAssetId":{"oneOf":[{"type":"string","description":"Identifier of the agent asset the alert relates to - the id `GET /v1/assets/agents/{agentAssetId}`\r\ntakes. Null when there is none, and on an alert about a custom asset or an uptime.","format":"uuid","uniqueKey":"Data.AgentAssetId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Identifier of the agent asset the alert relates to - the id `GET /v1/assets/agents/{agentAssetId}`\r\ntakes. Null when there is none, and on an alert about a custom asset or an uptime.","format":"uuid","uniqueKey":"Data.AgentAssetId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.AgentAssetId","typeLabel":"string\u003cuuid> | null"},"DeviceId":{"oneOf":[{"type":"string","description":"Identifier of the agent asset the alert relates to. \u003cb>Deprecated:\u003c/b> use `AgentAssetId`,\r\nwhich has the same value.","format":"uuid","deprecated":true,"uniqueKey":"Data.DeviceId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Identifier of the agent asset the alert relates to. \u003cb>Deprecated:\u003c/b> use `AgentAssetId`,\r\nwhich has the same value.","format":"uuid","deprecated":true,"uniqueKey":"Data.DeviceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.DeviceId","typeLabel":"string\u003cuuid> | null"},"CustomAssetId":{"oneOf":[{"type":"string","description":"Identifier of the custom asset the alert relates to - the id `GET /v1/assets/custom/{customAssetId}`\r\ntakes. Set on a `Warranty Expiration` alert about a custom asset and on an `API` alert posted with a\r\n`CustomAssetId`; null on every other alert.","format":"uuid","uniqueKey":"Data.CustomAssetId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Identifier of the custom asset the alert relates to - the id `GET /v1/assets/custom/{customAssetId}`\r\ntakes. Set on a `Warranty Expiration` alert about a custom asset and on an `API` alert posted with a\r\n`CustomAssetId`; null on every other alert.","format":"uuid","uniqueKey":"Data.CustomAssetId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.CustomAssetId","typeLabel":"string\u003cuuid> | null"},"CheckId":{"oneOf":[{"type":"string","description":"The check that raised this alert - a reusable check definition applied to devices\r\nthrough a policy, not a per-device record. Null on alerts not raised by one, including\r\nuptime alerts, which carry `UptimeId` instead.","uniqueKey":"Data.CheckId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The check that raised this alert - a reusable check definition applied to devices\r\nthrough a policy, not a per-device record. Null on alerts not raised by one, including\r\nuptime alerts, which carry `UptimeId` instead.","uniqueKey":"Data.CheckId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.CheckId","typeLabel":"string | null"},"UptimeId":{"oneOf":[{"type":"string","description":"The uptime that raised this alert, for `Uptime` alerts only - the same\r\nidentifier `GET /v1/uptime/{uptimeId}` takes. At most one of this and\r\n`CheckId` is set.","format":"uuid","uniqueKey":"Data.UptimeId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The uptime that raised this alert, for `Uptime` alerts only - the same\r\nidentifier `GET /v1/uptime/{uptimeId}` takes. At most one of this and\r\n`CheckId` is set.","format":"uuid","uniqueKey":"Data.UptimeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UptimeId","typeLabel":"string\u003cuuid> | null"},"UptimeCheckId":{"oneOf":[{"type":"string","description":"The uptime that raised this alert. \u003cb>Deprecated:\u003c/b> use `UptimeId`, which has the same value.","format":"uuid","deprecated":true,"uniqueKey":"Data.UptimeCheckId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The uptime that raised this alert. \u003cb>Deprecated:\u003c/b> use `UptimeId`, which has the same value.","format":"uuid","deprecated":true,"uniqueKey":"Data.UptimeCheckId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UptimeCheckId","typeLabel":"string\u003cuuid> | null"},"TicketId":{"oneOf":[{"type":"string","description":"Identifier of the ticket created from this alert. Null when no ticket has been created.","format":"uuid","uniqueKey":"Data.TicketId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Identifier of the ticket created from this alert. Null when no ticket has been created.","format":"uuid","uniqueKey":"Data.TicketId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.TicketId","typeLabel":"string\u003cuuid> | null"},"ContractId":{"oneOf":[{"type":"integer","description":"The contract behind a `Contract Expiration` alert. Null on every other alert.\r\n \r\n\n\r\nThe identifier `GET /v1/contracts/{contractId}` takes, so an expiration alert resolves\r\nto its contract without a second lookup.\r\n","format":"int64","uniqueKey":"Data.ContractId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"The contract behind a `Contract Expiration` alert. Null on every other alert.\r\n \r\n\n\r\nThe identifier `GET /v1/contracts/{contractId}` takes, so an expiration alert resolves\r\nto its contract without a second lookup.\r\n","format":"int64","uniqueKey":"Data.ContractId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ContractId","typeLabel":"integer\u003cint64> | null"},"DomainId":{"oneOf":[{"type":"integer","description":"The web domain behind a `Domain Expiration` alert. Null on every other alert.\r\n \r\n\n\r\nIdentifies the expiring domain, so it distinguishes - and lets a caller group - the many\r\nalerts a single domain produces as its expiry approaches.\r\n","format":"int64","uniqueKey":"Data.DomainId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"The web domain behind a `Domain Expiration` alert. Null on every other alert.\r\n \r\n\n\r\nIdentifies the expiring domain, so it distinguishes - and lets a caller group - the many\r\nalerts a single domain produces as its expiry approaches.\r\n","format":"int64","uniqueKey":"Data.DomainId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.DomainId","typeLabel":"integer\u003cint64> | null"},"DismissedOn":{"oneOf":[{"type":"string","description":"When the alert was dismissed (UTC), or null when it is not dismissed. The same value the\r\napp shows under \"Dismiss - By/On\".","format":"date-time","uniqueKey":"Data.DismissedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the alert was dismissed (UTC), or null when it is not dismissed. The same value the\r\napp shows under \"Dismiss - By/On\".","format":"date-time","uniqueKey":"Data.DismissedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.DismissedOn","typeLabel":"string\u003cdate-time> | null"},"DismissedBy":{"oneOf":[{"type":"integer","description":"Identifier of the technician who dismissed the alert, or null when it is not dismissed.\r\nResolve it with the technician endpoint.\r\n \r\n\n\r\nAlso null when the alert was dismissed automatically rather than by a person, so an\r\nauto-dismissal cannot currently be told apart from an unattributed one.\r\n","format":"int64","uniqueKey":"Data.DismissedBy.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the technician who dismissed the alert, or null when it is not dismissed.\r\nResolve it with the technician endpoint.\r\n \r\n\n\r\nAlso null when the alert was dismissed automatically rather than by a person, so an\r\nauto-dismissal cannot currently be told apart from an unattributed one.\r\n","format":"int64","uniqueKey":"Data.DismissedBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.DismissedBy","typeLabel":"integer\u003cint64> | null"},"CreatedOn":{"type":"string","description":"When the alert was raised (UTC).","format":"date-time","uniqueKey":"Data.CreatedOn","typeLabel":"string\u003cdate-time>"},"UpdatedOn":{"oneOf":[{"type":"string","description":"When the alert was last updated (UTC).","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the alert was last updated (UTC).","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UpdatedOn","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"An alert as returned by the alert list endpoint. All timestamps are UTC.","uniqueKey":"Data","typeLabel":"object"},"DataContext":{"oneOf":[{"type":"object","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext","typeLabel":"object | null"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":{"Id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Title":"\u003cstring>","Type":{"Id":1,"Name":"\u003cstring>"},"Severity":{"Id":1,"Name":"\u003cstring>"},"Status":{"Id":1,"Name":"\u003cstring>"},"Message":"\u003cstring>","ClientId":123,"AgentAssetId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","DeviceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","CustomAssetId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","CheckId":"\u003cstring>","UptimeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","UptimeCheckId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","TicketId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","ContractId":123,"DomainId":123,"DismissedOn":"2023-11-07T05:31:56Z","DismissedBy":123,"CreatedOn":"2023-11-07T05:31:56Z","UpdatedOn":"2023-11-07T05:31:56Z"},"DataContext":null,"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"type":"object","properties":{"Id":{"type":"string","description":"Alert identifier.","format":"uuid","uniqueKey":"Data.Id","typeLabel":"string\u003cuuid>"},"Title":{"type":"string","description":"The alert's subject, as the app's alert list shows it after the type - e.g.\r\n`\"Safari not found\"` for a Process alert, `\"Sentinel Agent Missing\"` for an\r\nAntivirus one, `\"Expires in 10 days\"` for an expiration.","uniqueKey":"Data.Title","typeLabel":"string"},"Type":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Type.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Type.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Type","typeLabel":"object"},"Severity":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Severity.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Severity.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Severity","typeLabel":"object"},"Status":{"type":"object","properties":{"Id":{"type":"integer","description":"Numeric identifier of the coded value (e.g. status, priority, type, or source id).","format":"int64","example":1,"uniqueKey":"Data.Status.Id","typeLabel":"integer\u003cint64>"},"Name":{"type":"string","description":"Display name of the coded value.","uniqueKey":"Data.Status.Name","typeLabel":"string"}},"additionalProperties":false,"description":"A coded value, such as a status, priority, type or source, as an id and a display name.","uniqueKey":"Data.Status","typeLabel":"object"},"Message":{"type":"string","description":"The alert's message. Empty for uptime and external alerts.","uniqueKey":"Data.Message","typeLabel":"string"},"ClientId":{"oneOf":[{"type":"integer","description":"Identifier of the client the alert relates to. Null when the alert's type does not\r\ncarry a client (uptime, external and script alerts).","format":"int64","uniqueKey":"Data.ClientId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the client the alert relates to. Null when the alert's type does not\r\ncarry a client (uptime, external and script alerts).","format":"int64","uniqueKey":"Data.ClientId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ClientId","typeLabel":"integer\u003cint64> | null"},"AgentAssetId":{"oneOf":[{"type":"string","description":"Identifier of the agent asset the alert relates to - the id `GET /v1/assets/agents/{agentAssetId}`\r\ntakes. Null when there is none, and on an alert about a custom asset or an uptime.","format":"uuid","uniqueKey":"Data.AgentAssetId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Identifier of the agent asset the alert relates to - the id `GET /v1/assets/agents/{agentAssetId}`\r\ntakes. Null when there is none, and on an alert about a custom asset or an uptime.","format":"uuid","uniqueKey":"Data.AgentAssetId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.AgentAssetId","typeLabel":"string\u003cuuid> | null"},"DeviceId":{"oneOf":[{"type":"string","description":"Identifier of the agent asset the alert relates to. \u003cb>Deprecated:\u003c/b> use `AgentAssetId`,\r\nwhich has the same value.","format":"uuid","deprecated":true,"uniqueKey":"Data.DeviceId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Identifier of the agent asset the alert relates to. \u003cb>Deprecated:\u003c/b> use `AgentAssetId`,\r\nwhich has the same value.","format":"uuid","deprecated":true,"uniqueKey":"Data.DeviceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.DeviceId","typeLabel":"string\u003cuuid> | null"},"CustomAssetId":{"oneOf":[{"type":"string","description":"Identifier of the custom asset the alert relates to - the id `GET /v1/assets/custom/{customAssetId}`\r\ntakes. Set on a `Warranty Expiration` alert about a custom asset and on an `API` alert posted with a\r\n`CustomAssetId`; null on every other alert.","format":"uuid","uniqueKey":"Data.CustomAssetId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Identifier of the custom asset the alert relates to - the id `GET /v1/assets/custom/{customAssetId}`\r\ntakes. Set on a `Warranty Expiration` alert about a custom asset and on an `API` alert posted with a\r\n`CustomAssetId`; null on every other alert.","format":"uuid","uniqueKey":"Data.CustomAssetId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.CustomAssetId","typeLabel":"string\u003cuuid> | null"},"CheckId":{"oneOf":[{"type":"string","description":"The check that raised this alert - a reusable check definition applied to devices\r\nthrough a policy, not a per-device record. Null on alerts not raised by one, including\r\nuptime alerts, which carry `UptimeId` instead.","uniqueKey":"Data.CheckId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The check that raised this alert - a reusable check definition applied to devices\r\nthrough a policy, not a per-device record. Null on alerts not raised by one, including\r\nuptime alerts, which carry `UptimeId` instead.","uniqueKey":"Data.CheckId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.CheckId","typeLabel":"string | null"},"UptimeId":{"oneOf":[{"type":"string","description":"The uptime that raised this alert, for `Uptime` alerts only - the same\r\nidentifier `GET /v1/uptime/{uptimeId}` takes. At most one of this and\r\n`CheckId` is set.","format":"uuid","uniqueKey":"Data.UptimeId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The uptime that raised this alert, for `Uptime` alerts only - the same\r\nidentifier `GET /v1/uptime/{uptimeId}` takes. At most one of this and\r\n`CheckId` is set.","format":"uuid","uniqueKey":"Data.UptimeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UptimeId","typeLabel":"string\u003cuuid> | null"},"UptimeCheckId":{"oneOf":[{"type":"string","description":"The uptime that raised this alert. \u003cb>Deprecated:\u003c/b> use `UptimeId`, which has the same value.","format":"uuid","deprecated":true,"uniqueKey":"Data.UptimeCheckId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"The uptime that raised this alert. \u003cb>Deprecated:\u003c/b> use `UptimeId`, which has the same value.","format":"uuid","deprecated":true,"uniqueKey":"Data.UptimeCheckId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UptimeCheckId","typeLabel":"string\u003cuuid> | null"},"TicketId":{"oneOf":[{"type":"string","description":"Identifier of the ticket created from this alert. Null when no ticket has been created.","format":"uuid","uniqueKey":"Data.TicketId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Identifier of the ticket created from this alert. Null when no ticket has been created.","format":"uuid","uniqueKey":"Data.TicketId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.TicketId","typeLabel":"string\u003cuuid> | null"},"ContractId":{"oneOf":[{"type":"integer","description":"The contract behind a `Contract Expiration` alert. Null on every other alert.\r\n \r\n\n\r\nThe identifier `GET /v1/contracts/{contractId}` takes, so an expiration alert resolves\r\nto its contract without a second lookup.\r\n","format":"int64","uniqueKey":"Data.ContractId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"The contract behind a `Contract Expiration` alert. Null on every other alert.\r\n \r\n\n\r\nThe identifier `GET /v1/contracts/{contractId}` takes, so an expiration alert resolves\r\nto its contract without a second lookup.\r\n","format":"int64","uniqueKey":"Data.ContractId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.ContractId","typeLabel":"integer\u003cint64> | null"},"DomainId":{"oneOf":[{"type":"integer","description":"The web domain behind a `Domain Expiration` alert. Null on every other alert.\r\n \r\n\n\r\nIdentifies the expiring domain, so it distinguishes - and lets a caller group - the many\r\nalerts a single domain produces as its expiry approaches.\r\n","format":"int64","uniqueKey":"Data.DomainId.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"The web domain behind a `Domain Expiration` alert. Null on every other alert.\r\n \r\n\n\r\nIdentifies the expiring domain, so it distinguishes - and lets a caller group - the many\r\nalerts a single domain produces as its expiry approaches.\r\n","format":"int64","uniqueKey":"Data.DomainId.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.DomainId","typeLabel":"integer\u003cint64> | null"},"DismissedOn":{"oneOf":[{"type":"string","description":"When the alert was dismissed (UTC), or null when it is not dismissed. The same value the\r\napp shows under \"Dismiss - By/On\".","format":"date-time","uniqueKey":"Data.DismissedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the alert was dismissed (UTC), or null when it is not dismissed. The same value the\r\napp shows under \"Dismiss - By/On\".","format":"date-time","uniqueKey":"Data.DismissedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.DismissedOn","typeLabel":"string\u003cdate-time> | null"},"DismissedBy":{"oneOf":[{"type":"integer","description":"Identifier of the technician who dismissed the alert, or null when it is not dismissed.\r\nResolve it with the technician endpoint.\r\n \r\n\n\r\nAlso null when the alert was dismissed automatically rather than by a person, so an\r\nauto-dismissal cannot currently be told apart from an unattributed one.\r\n","format":"int64","uniqueKey":"Data.DismissedBy.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Identifier of the technician who dismissed the alert, or null when it is not dismissed.\r\nResolve it with the technician endpoint.\r\n \r\n\n\r\nAlso null when the alert was dismissed automatically rather than by a person, so an\r\nauto-dismissal cannot currently be told apart from an unattributed one.\r\n","format":"int64","uniqueKey":"Data.DismissedBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.DismissedBy","typeLabel":"integer\u003cint64> | null"},"CreatedOn":{"type":"string","description":"When the alert was raised (UTC).","format":"date-time","uniqueKey":"Data.CreatedOn","typeLabel":"string\u003cdate-time>"},"UpdatedOn":{"oneOf":[{"type":"string","description":"When the alert was last updated (UTC).","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the alert was last updated (UTC).","format":"date-time","uniqueKey":"Data.UpdatedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data.UpdatedOn","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"description":"An alert as returned by the alert list endpoint. All timestamps are UTC.","uniqueKey":"Data","typeLabel":"object"},"DataContext":{"oneOf":[{"type":"object","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"example":null,"uniqueKey":"DataContext.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext","typeLabel":"object | null"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":{"Id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","Title":"\u003cstring>","Type":{"Id":1,"Name":"\u003cstring>"},"Severity":{"Id":1,"Name":"\u003cstring>"},"Status":{"Id":1,"Name":"\u003cstring>"},"Message":"\u003cstring>","ClientId":123,"AgentAssetId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","DeviceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","CustomAssetId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","CheckId":"\u003cstring>","UptimeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","UptimeCheckId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","TicketId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","ContractId":123,"DomainId":123,"DismissedOn":"2023-11-07T05:31:56Z","DismissedBy":123,"CreatedOn":"2023-11-07T05:31:56Z","UpdatedOn":"2023-11-07T05:31:56Z"},"DataContext":null,"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"6196b255-c052-4e2c-bb62-4c2a8900b59c":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"14cae6e6-b376-4340-b4db-8cfd5de6f711":{"description":"Not Found","content":{"text/plain":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"88e9dc52-11cd-4a62-90c2-22fab662e5e1":{"description":"Internal Server Error","content":{"text/plain":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"},"text/json":{"schema":{"type":"object","properties":{"StatusCode":{"enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511],"type":"integer","format":"int32","uniqueKey":"StatusCode","typeLabel":"enum\u003cinteger>"},"IsSuccess":{"type":"boolean","uniqueKey":"IsSuccess","typeLabel":"boolean"},"Data":{"oneOf":[{},{"type":"null","uniqueKey":"Data.oneOf.1","typeLabel":"null"}],"uniqueKey":"Data","typeLabel":"null"},"DataContext":{"type":"object","properties":{"TraceId":{"oneOf":[{"type":"string","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request correlation id. Quote this when reporting a problem.","uniqueKey":"DataContext.TraceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"DataContext.TraceId","typeLabel":"string | null"}},"additionalProperties":false,"description":"The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest.","uniqueKey":"DataContext","typeLabel":"object"},"Notifications":{"type":"array","items":{"type":"object","properties":{"Code":{"pattern":"^[0-9]{6}$","type":"string","description":"6-digit MMTTNN error code. See the Public API error-code registry.","example":"070101","uniqueKey":"Notifications.items.[INDEX].Code","typeLabel":"string"},"Message":{"type":"string","uniqueKey":"Notifications.items.[INDEX].Message","typeLabel":"string"},"PropertyName":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].PropertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].PropertyName","typeLabel":"string | null"},"ActionHint":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].ActionHint.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].ActionHint","typeLabel":"string | null"},"DocUrl":{"oneOf":[{"type":"string","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"Notifications.items.[INDEX].DocUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"Notifications.items.[INDEX].DocUrl","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"Notifications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"Notifications","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"StatusCode":100,"IsSuccess":true,"Data":"\u003cunknown>","DataContext":{"TraceId":"\u003cstring>"},"Notifications":[{"Code":"070101","Message":"\u003cstring>","PropertyName":"\u003cstring>","ActionHint":"\u003cstring>","DocUrl":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7b6acf03-bfa6-4539-9826-c3ecbd3f6d24":{"ApiKeyAuth":{"type":"apiKey","description":"Your Gorelo API key. See [Generate API key](/generate-api-key). If your data is hosted in Australia, click the base URL at the top of this page and select `https://api.aue.gorelo.io`.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"b46ffe4c-4a54-4e1e-a59b-94a3878c23e4":{"url":"https://api.usw.gorelo.io","description":"US"},"31fc67d7-965e-4c8a-946c-9895ebae16df":{"url":"https://api.aue.gorelo.io","description":"Australia"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Your Gorelo API key. See [Generate API key](/generate-api-key). If your data is hosted in Australia, click the base URL at the top of this page and select `https://api.aue.gorelo.io`.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"Your Gorelo API key. See [Generate API key](/generate-api-key). If your data is hosted in Australia, click the base URL at the top of this page and select `https://api.aue.gorelo.io`.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"gorelo","siteName":"Gorelo Documentation","title":"Gets a single alert by id. - Gorelo Documentation","contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/alerts/gets-a-single-alert-by-id","matchLevel":1},"ar":{"href":"/ar/api-reference/alerts/gets-a-single-alert-by-id","matchLevel":1},"pt-BR":{"href":"/pt-br/api-reference/alerts/gets-a-single-alert-by-id","matchLevel":1},"fr-CA":{"href":"/fr-ca/api-reference/alerts/gets-a-single-alert-by-id","matchLevel":0},"ca":{"href":"/ca/api-reference/alerts/gets-a-single-alert-by-id","matchLevel":1},"cn":{"href":"/cn/api-reference/alerts/gets-a-single-alert-by-id","matchLevel":1},"zh":{"href":"/zh/api-reference/alerts/gets-a-single-alert-by-id","matchLevel":1}}},"lastModified":"2026-10-29T15:07:52.720Z","originalFileLocation":"fr-ca/api-reference/alerts/gets-a-single-alert-by-id.mdx","locale":"fr-CA"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns the same fields as an item of GET /v1/alerts.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gorelo Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Gets a single alert by id. - Gorelo Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the same fields as an item of GET /v1/alerts.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gorelo Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.gorelo.io/fr-ca/api-reference/alerts/gets-a-single-alert-by-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gorelo.mintlify.app/_mintlify/api/og/v2?division=Alerts\u0026amp;title=Gets+a+single+alert+by+id.\u0026amp;description=Returns+the+same+fields+as+an+item+of+%60GET+%2Fv1%2Falerts%60.\u0026amp;theme=13a01696fc0cf71f5fdb322b\u0026amp;signature=da5c713e04e6e108b31641cb7e1acf7080089e5c3eb8484058bec81a8f1f66b4\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Gets a single alert by id. - Gorelo Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the same fields as an item of GET /v1/alerts.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gorelo.mintlify.app/_mintlify/api/og/v2?division=Alerts\u0026amp;title=Gets+a+single+alert+by+id.\u0026amp;description=Returns+the+same+fields+as+an+item+of+%60GET+%2Fv1%2Falerts%60.\u0026amp;theme=13a01696fc0cf71f5fdb322b\u0026amp;signature=da5c713e04e6e108b31641cb7e1acf7080089e5c3eb8484058bec81a8f1f66b4\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/gorelo/WDrabCfHIb0Y7HhN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gorelo Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1DAF94\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.gorelo.io/fr-ca/api-reference/alerts/gets-a-single-alert-by-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/fr-ca/api-reference/alerts/gets-a-single-alert-by-id.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr-CA\" href=\"https://help.gorelo.io/fr-ca/api-reference/alerts/gets-a-single-alert-by-id\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://help.gorelo.io/api-reference/alerts/gets-a-single-alert-by-id\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ar\" href=\"https://help.gorelo.io/ar/api-reference/alerts/gets-a-single-alert-by-id\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://help.gorelo.io/pt-br/api-reference/alerts/gets-a-single-alert-by-id\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ca\" href=\"https://help.gorelo.io/ca/api-reference/alerts/gets-a-single-alert-by-id\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://help.gorelo.io/cn/api-reference/alerts/gets-a-single-alert-by-id\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://help.gorelo.io/api-reference/alerts/gets-a-single-alert-by-id\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.gorelo.io/#organization\",\"name\":\"Gorelo Documentation\",\"url\":\"https://help.gorelo.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gorelo/J8h_fLstMj_tYUTJ/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=J8h_fLstMj_tYUTJ\u0026q=85\u0026s=3c12ffa7afbcef131d2c6fb36f00e159\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.gorelo.io#website\",\"name\":\"Gorelo Documentation\",\"url\":\"https://help.gorelo.io\",\"publisher\":{\"@id\":\"https://help.gorelo.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.gorelo.io/fr-ca/api-reference/alerts/gets-a-single-alert-by-id#webpage\",\"url\":\"https://help.gorelo.io/fr-ca/api-reference/alerts/gets-a-single-alert-by-id\",\"name\":\"Gets a single alert by id.\",\"description\":\"Returns the same fields as an item of GET /v1/alerts.\",\"dateModified\":\"2026-10-29T15:07:52.720Z\",\"isPartOf\":{\"@id\":\"https://help.gorelo.io#website\"},\"breadcrumb\":{\"@id\":\"https://help.gorelo.io/fr-ca/api-reference/alerts/gets-a-single-alert-by-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.gorelo.io/fr-ca/api-reference/alerts/gets-a-single-alert-by-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Référence de l'API\",\"item\":\"https://help.gorelo.io/fr-ca/api-reference/alerts/lists-alerts-for-the-authenticated-service-provider\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Alerts\",\"item\":\"https://help.gorelo.io/fr-ca/api-reference/alerts/lists-alerts-for-the-authenticated-service-provider\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Gets a single alert by id.\",\"item\":\"https://help.gorelo.io/fr-ca/api-reference/alerts/gets-a-single-alert-by-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://help.gorelo.io/fr-ca/api-reference/alerts/gets-a-single-alert-by-id#apireference\",\"headline\":\"Gets a single alert by id.\",\"name\":\"Gets a single alert by id.\",\"description\":\"Returns the same fields as an item of GET /v1/alerts.\",\"url\":\"https://help.gorelo.io/fr-ca/api-reference/alerts/gets-a-single-alert-by-id\",\"mainEntityOfPage\":{\"@id\":\"https://help.gorelo.io/fr-ca/api-reference/alerts/gets-a-single-alert-by-id#webpage\"},\"dateModified\":\"2026-10-29T15:07:52.720Z\",\"publisher\":{\"@id\":\"https://help.gorelo.io/#organization\"},\"isPartOf\":{\"@id\":\"https://help.gorelo.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gorelo Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gorelo Documentation","nav":{"global":null,"languages":[{"language":"en","default":true,"pages":[{"title":"en","href":"/api-reference/alerts/gets-a-single-alert-by-id"}]},{"language":"ar","pages":[{"title":"ar","href":"/ar/api-reference/alerts/gets-a-single-alert-by-id"}]},{"language":"pt-BR","pages":[{"title":"pt-BR","href":"/pt-br/api-reference/alerts/gets-a-single-alert-by-id"}]},{"language":"fr-CA","tabs":[{"tab":"Pour commencer","icon":"rocket-launch","pages":[{"title":"Pour commencer","href":"/fr-CA/what-is-gorelo"}]},{"tab":"Prestation de services","icon":"bell","pages":[{"title":"Prestation de services","href":"/fr-CA/sd-overview"}]},{"tab":"Gestion à distance","icon":"desktop","pages":[{"title":"Gestion à distance","href":"/fr-CA/remote-management-overview"}]},{"tab":"Facturation","icon":"sack-dollar","pages":[{"title":"Facturation","href":"/fr-CA/how-billing-works"}]},{"tab":"Intégrations","icon":"plug","pages":[{"title":"Intégrations","href":"/fr-CA/integrations-overview"}]},{"tab":"API","icon":"satellite-dish","pages":[{"title":"Aperçu de l'API Gorelo","href":"/fr-CA/api-overview"},{"title":"Générer une clé API","href":"/fr-CA/generate-api-key"},{"title":"Révoquer une clé API","href":"/fr-CA/revoke-api-key"},{"group":"Référence de l'API","pages":[{"group":"Alerts","pages":[{"title":"Lists alerts for the authenticated service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/alerts","href":"/fr-ca/api-reference/alerts/lists-alerts-for-the-authenticated-service-provider"},{"title":"Posts an external alert against a client for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/alerts","href":"/fr-ca/api-reference/alerts/posts-an-external-alert-against-a-client-for-the-service-provider"},{"title":"Changes the status of several alerts at once.","description":"Sets `StatusId` - 1 New, 2 Dismissed or 3 Ticketed - on every alert in `AlertIds`, up to\r\n100. Ticketed links every alert to the one ticket in `TicketId`, as the app does when a ticket is\r\ncreated from several alerts. Each alert's whole stack changes with it, and the same changes are\r\nrefused with 409 as for a single alert.\r\nEvery id must be an alert of this account: if any is not, the request is a 400 naming them and\r\nnothing is changed; nor is anything changed when any alert is refused. An alert that already has\r\nthe status is left alone and is not listed in `UpdatedIds`, so a retried request is safe.\r\n`UpdatedIds` lists the alerts named first, in the order given, then the rest of their stacks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/alerts","href":"/fr-ca/api-reference/alerts/changes-the-status-of-several-alerts-at-once"},{"title":"Gets a single alert by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/alerts/{alertId}","href":"/fr-ca/api-reference/alerts/gets-a-single-alert-by-id"},{"title":"Changes an alert's status: dismisses it, restores it to New, or links it to a ticket.","description":"`StatusId` is required: 1 New, 2 Dismissed or 3 Ticketed. Ticketed needs a `TicketId` - an\r\n open ticket of this account, of the alert's client when it has one - and links the alert to it, as\r\n creating a ticket from an alert does in the app; the alert's `TicketId` then reads that ticket.\r\n `TicketId` is refused with any other status.\r\n \n\r\n As in the app, the change applies to the alert's whole stack - the repeats grouped with it in the\r\n alert list: dismissing or ticketing moves every New alert in the stack, and restoring to New moves\r\n every Dismissed one back. A New alert can be dismissed or ticketed and a Dismissed alert restored;\r\n any other change - a Ticketed alert to any status or another ticket, or a Dismissed alert to\r\n Ticketed - is a 409. Sending the status (and ticket) the alert already has is a no-op rather than an\r\n error. A dismissal is reported on the alert as `DismissedOn` and `DismissedBy`.\r\n ","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/alerts/{alertId}","href":"/fr-ca/api-reference/alerts/changes-an-alerts-status:-dismisses-it-restores-it-to-new-or-links-it-to-a-ticket"}]},{"group":"Assets","pages":[{"title":"Lists agent assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents","href":"/fr-ca/api-reference/assets/lists-agent-assets"},{"title":"Lists custom assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/custom","href":"/fr-ca/api-reference/assets/lists-custom-assets"},{"title":"Creates a custom asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/assets/custom","href":"/fr-ca/api-reference/assets/creates-a-custom-asset"},{"title":"Gets a single custom asset by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/custom/{customAssetId}","href":"/fr-ca/api-reference/assets/gets-a-single-custom-asset-by-id"},{"title":"Deletes a custom asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/assets/custom/{customAssetId}","href":"/fr-ca/api-reference/assets/deletes-a-custom-asset"},{"title":"Updates a custom asset. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/assets/custom/{customAssetId}","href":"/fr-ca/api-reference/assets/updates-a-custom-asset-send-only-the-fields-you-want-to-change"},{"title":"Gets a single agent (managed device) asset by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}","href":"/fr-ca/api-reference/assets/gets-a-single-agent-managed-device-asset-by-id"},{"title":"Deletes an agent (managed device) asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/assets/agents/{agentAssetId}","href":"/fr-ca/api-reference/assets/deletes-an-agent-managed-device-asset"},{"title":"Updates an agent (managed device) asset. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/assets/agents/{agentAssetId}","href":"/fr-ca/api-reference/assets/updates-an-agent-managed-device-asset-send-only-the-fields-you-want-to-change"},{"title":"Lists the patches installed on an agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/patches","href":"/fr-ca/api-reference/assets/lists-the-patches-installed-on-an-agent"},{"title":"Lists the Windows updates pending on an agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/patches/available","href":"/fr-ca/api-reference/assets/lists-the-windows-updates-pending-on-an-agent"},{"title":"Lists the applications installed on an agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/apps","href":"/fr-ca/api-reference/assets/lists-the-applications-installed-on-an-agent"},{"title":"Gets an agent's processors, memory and disks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/hardware","href":"/fr-ca/api-reference/assets/gets-an-agents-processors-memory-and-disks"},{"title":"Lists the tags on an agent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/agents/{agentAssetId}/tags","href":"/fr-ca/api-reference/assets/lists-the-tags-on-an-agent"},{"title":"Lists the service provider's scripts using cursor pagination.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/scripts","href":"/fr-ca/api-reference/assets/lists-the-service-providers-scripts-using-cursor-pagination"},{"title":"Gets a script, with its content.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/scripts/{scriptId}","href":"/fr-ca/api-reference/assets/gets-a-script-with-its-content"},{"title":"Lists the asset types.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/types","href":"/fr-ca/api-reference/assets/lists-the-asset-types"},{"title":"Creates an asset type.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/assets/types","href":"/fr-ca/api-reference/assets/creates-an-asset-type"},{"title":"Lists the asset tags.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/tags","href":"/fr-ca/api-reference/assets/lists-the-asset-tags"},{"title":"Gets a single asset tag by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/tags/{tagId}","href":"/fr-ca/api-reference/assets/gets-a-single-asset-tag-by-id"},{"title":"Lists the service provider's monitoring policies using cursor pagination.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/policies","href":"/fr-ca/api-reference/assets/lists-the-service-providers-monitoring-policies-using-cursor-pagination"},{"title":"Gets a single monitoring policy by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/policies/{policyId}","href":"/fr-ca/api-reference/assets/gets-a-single-monitoring-policy-by-id"},{"title":"Deletes an asset type.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/assets/types/{assetTypeId}","href":"/fr-ca/api-reference/assets/deletes-an-asset-type"},{"title":"Renames an asset type.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/assets/types/{assetTypeId}","href":"/fr-ca/api-reference/assets/renames-an-asset-type"},{"title":"Lists the hardware types a custom asset can be given. \u003cb>Deprecated:\u003c/b> use `GET /v1/assets/types`.","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json get /v1/assets/custom/hardware-types","href":"/fr-ca/api-reference/assets/lists-the-hardware-types-a-custom-asset-can-be-given-\u003cb>deprecated:\u003cb>-use-`get-v1assetstypes`"},{"title":"Lists uptime checks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/uptime","href":"/fr-ca/api-reference/assets/lists-uptime-checks"},{"title":"Creates an uptime check.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/uptime","href":"/fr-ca/api-reference/assets/creates-an-uptime-check"},{"title":"Gets a single uptime check by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/uptime/{uptimeId}","href":"/fr-ca/api-reference/assets/gets-a-single-uptime-check-by-id"},{"title":"Deletes an uptime check.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/uptime/{uptimeId}","href":"/fr-ca/api-reference/assets/deletes-an-uptime-check"},{"title":"Updates an uptime check. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/uptime/{uptimeId}","href":"/fr-ca/api-reference/assets/updates-an-uptime-check-send-only-the-fields-you-want-to-change"}]},{"group":"Attachments","pages":[{"title":"Uploads a file and returns a link to it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/attachments","href":"/fr-ca/api-reference/attachments/uploads-a-file-and-returns-a-link-to-it"}]},{"group":"Billing","pages":[{"title":"Downloads the rendered PDF for an invoice.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/invoices/{invoiceId}/pdf","href":"/fr-ca/api-reference/billing/downloads-the-rendered-pdf-for-an-invoice"},{"title":"Lists billing roles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/billing-roles","href":"/fr-ca/api-reference/billing/lists-billing-roles"},{"title":"Lists work types","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/work-types","href":"/fr-ca/api-reference/billing/lists-work-types"},{"title":"Lists the tax rates configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/taxes","href":"/fr-ca/api-reference/billing/lists-the-tax-rates-configured-for-the-service-provider"},{"title":"Lists logged time across every ticket and task, narrowed by any of the filters.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/time-entries","href":"/fr-ca/api-reference/billing/lists-logged-time-across-every-ticket-and-task-narrowed-by-any-of-the-filters"},{"title":"Logs time against a ticket.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/time-entries","href":"/fr-ca/api-reference/billing/logs-time-against-a-ticket"},{"title":"Gets a single time entry by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/time-entries/{timeEntryId}","href":"/fr-ca/api-reference/billing/gets-a-single-time-entry-by-id"},{"title":"Deletes a time entry.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/time-entries/{timeEntryId}","href":"/fr-ca/api-reference/billing/deletes-a-time-entry"},{"title":"Partially updates a time entry. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/time-entries/{timeEntryId}","href":"/fr-ca/api-reference/billing/partially-updates-a-time-entry-send-only-the-fields-you-want-to-change"},{"title":"Lists the products charged to tickets and to project tasks, narrowed by any of the filters.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/product-charges","href":"/fr-ca/api-reference/billing/lists-the-products-charged-to-tickets-and-to-project-tasks-narrowed-by-any-of-the-filters"},{"title":"Charges a catalog item to a ticket or to a project task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/product-charges","href":"/fr-ca/api-reference/billing/charges-a-catalog-item-to-a-ticket-or-to-a-project-task"},{"title":"Gets one product charge.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/product-charges/{productChargeId}","href":"/fr-ca/api-reference/billing/gets-one-product-charge"},{"title":"Removes a product charge from its ticket or task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/product-charges/{productChargeId}","href":"/fr-ca/api-reference/billing/removes-a-product-charge-from-its-ticket-or-task"},{"title":"Partially updates a product charge. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/product-charges/{productChargeId}","href":"/fr-ca/api-reference/billing/partially-updates-a-product-charge-send-only-the-fields-you-want-to-change"},{"title":"Lists billing contracts, each with the service lines it is made of.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contracts","href":"/fr-ca/api-reference/billing/lists-billing-contracts-each-with-the-service-lines-it-is-made-of"},{"title":"Creates a contract with its service lines.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contracts","href":"/fr-ca/api-reference/billing/creates-a-contract-with-its-service-lines"},{"title":"Everything about one contract, including each service line's actual products/labor.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contracts/{contractId}","href":"/fr-ca/api-reference/billing/everything-about-one-contract-including-each-service-lines-actual-productslabor"},{"title":"Deletes a contract.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contracts/{contractId}","href":"/fr-ca/api-reference/billing/deletes-a-contract"},{"title":"Updates a contract and its service lines.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contracts/{contractId}","href":"/fr-ca/api-reference/billing/updates-a-contract-and-its-service-lines"},{"title":"Lists the service provider's invoices, filtered and sorted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/invoices","href":"/fr-ca/api-reference/billing/lists-the-service-providers-invoices-filtered-and-sorted"},{"title":"Raises a manual invoice against a client, with line items.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/invoices","href":"/fr-ca/api-reference/billing/raises-a-manual-invoice-against-a-client-with-line-items"},{"title":"Gets one invoice, with its attachments and line items.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/invoices/{invoiceId}","href":"/fr-ca/api-reference/billing/gets-one-invoice-with-its-attachments-and-line-items"},{"title":"Deletes or voids an invoice, depending on its current status.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/invoices/{invoiceId}","href":"/fr-ca/api-reference/billing/deletes-or-voids-an-invoice-depending-on-its-current-status"},{"title":"Updates an invoice: its header fields, its status (approve only) and its lines.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/invoices/{invoiceId}","href":"/fr-ca/api-reference/billing/updates-an-invoice:-its-header-fields-its-status-approve-only-and-its-lines"},{"title":"Lists the payments received from clients, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/payments","href":"/fr-ca/api-reference/billing/lists-the-payments-received-from-clients-newest-first"},{"title":"Records a payment received outside Gorelo against an approved invoice.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/payments","href":"/fr-ca/api-reference/billing/records-a-payment-received-outside-gorelo-against-an-approved-invoice"},{"title":"Gets one payment, with the invoices it was applied to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/payments/{paymentId}","href":"/fr-ca/api-reference/billing/gets-one-payment-with-the-invoices-it-was-applied-to"},{"title":"Deletes a payment that was recorded through the API.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/payments/{paymentId}","href":"/fr-ca/api-reference/billing/deletes-a-payment-that-was-recorded-through-the-api"},{"title":"Lists the service provider's proposals - quotes sent to clients - newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/proposals","href":"/fr-ca/api-reference/billing/lists-the-service-providers-proposals--quotes-sent-to-clients--newest-first"},{"title":"Gets one proposal, with the products and bundles it quotes.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/proposals/{proposalId}","href":"/fr-ca/api-reference/billing/gets-one-proposal-with-the-products-and-bundles-it-quotes"},{"title":"Lists the categories products are organised under, each with its subcategories.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/items/categories","href":"/fr-ca/api-reference/billing/lists-the-categories-products-are-organised-under-each-with-its-subcategories"},{"title":"Lists the service provider's item catalog: products and bundles.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/items","href":"/fr-ca/api-reference/billing/lists-the-service-providers-item-catalog:-products-and-bundles"},{"title":"Creates a product or a bundle in the item catalog.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/items","href":"/fr-ca/api-reference/billing/creates-a-product-or-a-bundle-in-the-item-catalog"},{"title":"A single catalog item — a product or a bundle.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/items/{itemId}","href":"/fr-ca/api-reference/billing/a-single-catalog-item-—-a-product-or-a-bundle"},{"title":"Deletes an item.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/items/{itemId}","href":"/fr-ca/api-reference/billing/deletes-an-item"},{"title":"Partially updates an item. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/items/{itemId}","href":"/fr-ca/api-reference/billing/partially-updates-an-item-send-only-the-fields-you-want-to-change"}]},{"group":"Clients","pages":[{"title":"Lists clients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/clients","href":"/fr-ca/api-reference/clients/lists-clients"},{"title":"Creates a client (and its default location) for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/clients","href":"/fr-ca/api-reference/clients/creates-a-client-and-its-default-location-for-the-service-provider"},{"title":"Gets a single client by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/clients/{clientId}","href":"/fr-ca/api-reference/clients/gets-a-single-client-by-id"},{"title":"Deletes a client.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/clients/{clientId}","href":"/fr-ca/api-reference/clients/deletes-a-client"},{"title":"Updates an existing client. Only supplied (non-null) fields are changed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/clients/{clientId}","href":"/fr-ca/api-reference/clients/updates-an-existing-client-only-supplied-non-null-fields-are-changed"},{"title":"Lists the locations for a given client.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/clients/{clientId}/locations","href":"/fr-ca/api-reference/clients/lists-the-locations-for-a-given-client"},{"title":"Adds a location to a client.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/clients/{clientId}/locations","href":"/fr-ca/api-reference/clients/adds-a-location-to-a-client"},{"title":"Gets one location of a client.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/clients/{clientId}/locations/{locationId}","href":"/fr-ca/api-reference/clients/gets-one-location-of-a-client"},{"title":"Deletes a location of a client.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/clients/{clientId}/locations/{locationId}","href":"/fr-ca/api-reference/clients/deletes-a-location-of-a-client"},{"title":"Updates a location of a client. Only the fields sent are changed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/clients/{clientId}/locations/{locationId}","href":"/fr-ca/api-reference/clients/updates-a-location-of-a-client-only-the-fields-sent-are-changed"},{"title":"Lists the client types a client can be given.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/clients/types","href":"/fr-ca/api-reference/clients/lists-the-client-types-a-client-can-be-given"},{"title":"Lists the custom fields defined for clients.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/clients/custom-fields","href":"/fr-ca/api-reference/clients/lists-the-custom-fields-defined-for-clients"},{"title":"Adds a web domain to a client.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/clients/{clientId}/domains","href":"/fr-ca/api-reference/clients/adds-a-web-domain-to-a-client"},{"title":"Deletes a web domain of a client.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/clients/{clientId}/domains/{domainId}","href":"/fr-ca/api-reference/clients/deletes-a-web-domain-of-a-client"},{"title":"Updates a web domain of a client. Only the fields sent are changed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/clients/{clientId}/domains/{domainId}","href":"/fr-ca/api-reference/clients/updates-a-web-domain-of-a-client-only-the-fields-sent-are-changed"}]},{"group":"Contacts","pages":[{"title":"Gets a single contact by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/{contactId}","href":"/fr-ca/api-reference/contacts/gets-a-single-contact-by-id"},{"title":"Deletes a contact.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contacts/{contactId}","href":"/fr-ca/api-reference/contacts/deletes-a-contact"},{"title":"Updates an existing contact.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contacts/{contactId}","href":"/fr-ca/api-reference/contacts/updates-an-existing-contact"},{"title":"Lists the tags a contact can be given.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/tags","href":"/fr-ca/api-reference/contacts/lists-the-tags-a-contact-can-be-given"},{"title":"Lists contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/fr-ca/api-reference/contacts/lists-contacts"},{"title":"Creates a contact under a client, or a temporary contact when no client is given.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts","href":"/fr-ca/api-reference/contacts/creates-a-contact-under-a-client-or-a-temporary-contact-when-no-client-is-given"}]},{"group":"Deletions","pages":[{"title":"Lists deleted records","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/deletions","href":"/fr-ca/api-reference/deletions/lists-deleted-records"}]},{"group":"Documents","pages":[{"title":"Lists the service provider's documents.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents","href":"/fr-ca/api-reference/documents/lists-the-service-providers-documents"},{"title":"Creates a document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents","href":"/fr-ca/api-reference/documents/creates-a-document"},{"title":"Gets a single document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}","href":"/fr-ca/api-reference/documents/gets-a-single-document"},{"title":"Updates a document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/documents/{documentId}","href":"/fr-ca/api-reference/documents/updates-a-document"},{"title":"Duplicates a document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents/{documentId}/duplicate","href":"/fr-ca/api-reference/documents/duplicates-a-document"},{"title":"Downloads a document as a PDF.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}/pdf","href":"/fr-ca/api-reference/documents/downloads-a-document-as-a-pdf"},{"title":"Lists a document's versions, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}/versions","href":"/fr-ca/api-reference/documents/lists-a-documents-versions-newest-first"},{"title":"Gets one version of a document, with its body and attachments.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}/versions/{versionId}","href":"/fr-ca/api-reference/documents/gets-one-version-of-a-document-with-its-body-and-attachments"},{"title":"Makes an earlier version the current one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents/{documentId}/versions/{versionId}/restore","href":"/fr-ca/api-reference/documents/makes-an-earlier-version-the-current-one"},{"title":"Lists the records a document is related to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/{documentId}/related-items","href":"/fr-ca/api-reference/documents/lists-the-records-a-document-is-related-to"},{"title":"Relates a document to other records.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/documents/{documentId}/related-items","href":"/fr-ca/api-reference/documents/relates-a-document-to-other-records"},{"title":"Removes one related item from a document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/documents/{documentId}/related-items/{relatedItemId}","href":"/fr-ca/api-reference/documents/removes-one-related-item-from-a-document"},{"title":"Lists the structured documents - the account's question templates.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/structured","href":"/fr-ca/api-reference/documents/lists-the-structured-documents--the-accounts-question-templates"},{"title":"Gets a single structured document, with its fields.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/structured/{structuredDocumentId}","href":"/fr-ca/api-reference/documents/gets-a-single-structured-document-with-its-fields"},{"title":"Lists the submissions of a structured document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/structured/{structuredDocumentId}/submissions","href":"/fr-ca/api-reference/documents/lists-the-submissions-of-a-structured-document"},{"title":"Gets a single submission of a structured document, with its answers and attachments.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/documents/structured/{structuredDocumentId}/submissions/{submissionId}","href":"/fr-ca/api-reference/documents/gets-a-single-submission-of-a-structured-document-with-its-answers-and-attachments"}]},{"group":"Forms","pages":[{"title":"Lists the service provider's forms, most recently updated first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/forms","href":"/fr-ca/api-reference/forms/lists-the-service-providers-forms-most-recently-updated-first"},{"title":"Lists a form's submitted responses, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/forms/{formId}/responses","href":"/fr-ca/api-reference/forms/lists-a-forms-submitted-responses-newest-first"},{"title":"Issues a link through which the form can be submitted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/forms/{formId}/submission-links","href":"/fr-ca/api-reference/forms/issues-a-link-through-which-the-form-can-be-submitted"}]},{"group":"Organization","pages":[{"title":"Lists users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organization/users","href":"/fr-ca/api-reference/organization/lists-users"},{"title":"Returns one user (technician), with their role and the groups they are a member of.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organization/users/{userId}","href":"/fr-ca/api-reference/organization/returns-one-user-technician-with-their-role-and-the-groups-they-are-a-member-of"},{"title":"Lists user roles","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organization/roles","href":"/fr-ca/api-reference/organization/lists-user-roles"},{"title":"Lists the service provider's API keys using cursor pagination, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/api-keys","href":"/fr-ca/api-reference/organization/lists-the-service-providers-api-keys-using-cursor-pagination-newest-first"},{"title":"Creates an API key for the authenticated service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/api-keys","href":"/fr-ca/api-reference/organization/creates-an-api-key-for-the-authenticated-service-provider"},{"title":"Revokes an API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/api-keys/{apiKeyId}","href":"/fr-ca/api-reference/organization/revokes-an-api-key"},{"title":"Lists the technician groups configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organization/groups","href":"/fr-ca/api-reference/organization/lists-the-technician-groups-configured-for-the-service-provider"},{"title":"Returns one technician group, in the same shape as the group list.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/organization/groups/{groupId}","href":"/fr-ca/api-reference/organization/returns-one-technician-group-in-the-same-shape-as-the-group-list"}]},{"group":"Projects","pages":[{"title":"Lists the projects visible to the authenticated service provider, newest activity first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects","href":"/fr-ca/api-reference/projects/lists-the-projects-visible-to-the-authenticated-service-provider-newest-activity-first"},{"title":"Creates a project for the authenticated service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects","href":"/fr-ca/api-reference/projects/creates-a-project-for-the-authenticated-service-provider"},{"title":"Gets a single project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}","href":"/fr-ca/api-reference/projects/gets-a-single-project"},{"title":"Deletes a project and every task in it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}","href":"/fr-ca/api-reference/projects/deletes-a-project-and-every-task-in-it"},{"title":"Updates a project. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/projects/{projectId}","href":"/fr-ca/api-reference/projects/updates-a-project-send-only-the-fields-you-want-to-change"},{"title":"Lists the project tags configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/tags","href":"/fr-ca/api-reference/projects/lists-the-project-tags-configured-for-the-service-provider"},{"title":"Lists the project types configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/types","href":"/fr-ca/api-reference/projects/lists-the-project-types-configured-for-the-service-provider"},{"title":"Lists the project templates configured for the service provider, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/templates","href":"/fr-ca/api-reference/projects/lists-the-project-templates-configured-for-the-service-provider-newest-first"},{"title":"Lists a project's sections.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/sections","href":"/fr-ca/api-reference/projects/lists-a-projects-sections"},{"title":"Adds a section to a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/sections","href":"/fr-ca/api-reference/projects/adds-a-section-to-a-project"},{"title":"Deletes a section and every task in it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/sections/{sectionId}","href":"/fr-ca/api-reference/projects/deletes-a-section-and-every-task-in-it"},{"title":"Updates a section's title or colour. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/projects/{projectId}/sections/{sectionId}","href":"/fr-ca/api-reference/projects/updates-a-sections-title-or-colour-send-only-the-fields-you-want-to-change"},{"title":"Lists a project's tasks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks","href":"/fr-ca/api-reference/projects/lists-a-projects-tasks"},{"title":"Creates a task on a project's board.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/tasks","href":"/fr-ca/api-reference/projects/creates-a-task-on-a-projects-board"},{"title":"Returns a project's comments, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/comments","href":"/fr-ca/api-reference/projects/returns-a-projects-comments-newest-first"},{"title":"Posts a comment on a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/comments","href":"/fr-ca/api-reference/projects/posts-a-comment-on-a-project"},{"title":"Returns one comment on a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/comments/{commentId}","href":"/fr-ca/api-reference/projects/returns-one-comment-on-a-project"},{"title":"Deletes one comment on a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/comments/{commentId}","href":"/fr-ca/api-reference/projects/deletes-one-comment-on-a-project"},{"title":"Edits a private comment on a project. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/projects/{projectId}/comments/{commentId}","href":"/fr-ca/api-reference/projects/edits-a-private-comment-on-a-project-send-only-the-fields-you-want-to-change"},{"title":"Returns one task in full.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}","href":"/fr-ca/api-reference/projects/returns-one-task-in-full"},{"title":"Deletes a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/tasks/{taskId}","href":"/fr-ca/api-reference/projects/deletes-a-task"},{"title":"Updates a task. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/projects/{projectId}/tasks/{taskId}","href":"/fr-ca/api-reference/projects/updates-a-task-send-only-the-fields-you-want-to-change"},{"title":"Returns a task's comments, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}/comments","href":"/fr-ca/api-reference/projects/returns-a-tasks-comments-newest-first"},{"title":"Posts a comment on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/tasks/{taskId}/comments","href":"/fr-ca/api-reference/projects/posts-a-comment-on-a-task"},{"title":"Starts a side conversation on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/tasks/{taskId}/conversations/side-conversation","href":"/fr-ca/api-reference/projects/starts-a-side-conversation-on-a-task"},{"title":"Asks contacts to approve something on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/tasks/{taskId}/conversations/approval","href":"/fr-ca/api-reference/projects/asks-contacts-to-approve-something-on-a-task"},{"title":"Returns one comment on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}/comments/{commentId}","href":"/fr-ca/api-reference/projects/returns-one-comment-on-a-task"},{"title":"Deletes one comment on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/tasks/{taskId}/comments/{commentId}","href":"/fr-ca/api-reference/projects/deletes-one-comment-on-a-task"},{"title":"Edits a private comment on a task. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/projects/{projectId}/tasks/{taskId}/comments/{commentId}","href":"/fr-ca/api-reference/projects/edits-a-private-comment-on-a-task-send-only-the-fields-you-want-to-change"},{"title":"Lists the conversations on a task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}/conversations","href":"/fr-ca/api-reference/projects/lists-the-conversations-on-a-task"},{"title":"Gets one approval on a task, with its approvers.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/tasks/{taskId}/approvals/{approvalId}","href":"/fr-ca/api-reference/projects/gets-one-approval-on-a-task-with-its-approvers"}]},{"group":"Tickets","pages":[{"title":"Lists tickets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets","href":"/fr-ca/api-reference/tickets/lists-tickets"},{"title":"Creates a ticket for the authenticated service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tickets","href":"/fr-ca/api-reference/tickets/creates-a-ticket-for-the-authenticated-service-provider"},{"title":"Gets a single ticket.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}","href":"/fr-ca/api-reference/tickets/gets-a-single-ticket"},{"title":"Deletes a ticket and its time entries.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tickets/{ticketId}","href":"/fr-ca/api-reference/tickets/deletes-a-ticket-and-its-time-entries"},{"title":"Partially updates a ticket. Send only the fields you want to change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/tickets/{ticketId}","href":"/fr-ca/api-reference/tickets/partially-updates-a-ticket-send-only-the-fields-you-want-to-change"},{"title":"Gets a ticket comment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}/comments/{commentId}","href":"/fr-ca/api-reference/tickets/gets-a-ticket-comment"},{"title":"Deletes a private comment from a ticket.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tickets/{ticketId}/comments/{commentId}","href":"/fr-ca/api-reference/tickets/deletes-a-private-comment-from-a-ticket"},{"title":"Lists the ticket statuses configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/statuses","href":"/fr-ca/api-reference/tickets/lists-the-ticket-statuses-configured-for-the-service-provider"},{"title":"Lists the ticket tags configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/tags","href":"/fr-ca/api-reference/tickets/lists-the-ticket-tags-configured-for-the-service-provider"},{"title":"Lists the ticket types configured for the service provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/types","href":"/fr-ca/api-reference/tickets/lists-the-ticket-types-configured-for-the-service-provider"},{"title":"Lists the ticket priorities.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/priorities","href":"/fr-ca/api-reference/tickets/lists-the-ticket-priorities"},{"title":"Lists the ticket sources.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/sources","href":"/fr-ca/api-reference/tickets/lists-the-ticket-sources"},{"title":"Lists ticket comments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}/comments","href":"/fr-ca/api-reference/tickets/lists-ticket-comments"},{"title":"Adds a comment to a ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tickets/{ticketId}/comments","href":"/fr-ca/api-reference/tickets/adds-a-comment-to-a-ticket"},{"title":"Lists ticket conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}/conversations","href":"/fr-ca/api-reference/tickets/lists-ticket-conversations"},{"title":"Gets a ticket approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tickets/{ticketId}/approvals/{approvalId}","href":"/fr-ca/api-reference/tickets/gets-a-ticket-approval"},{"title":"Renames an approval on a ticket.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/tickets/{ticketId}/approvals/{approvalId}","href":"/fr-ca/api-reference/tickets/renames-an-approval-on-a-ticket"},{"title":"Creates an approval on a ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tickets/{ticketId}/conversations/approval","href":"/fr-ca/api-reference/tickets/creates-an-approval-on-a-ticket"},{"title":"Creates a side conversation on a ticket","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tickets/{ticketId}/conversations/side-conversation","href":"/fr-ca/api-reference/tickets/creates-a-side-conversation-on-a-ticket"}]}]}]}]},{"language":"ca","pages":[{"title":"ca","href":"/ca/api-reference/alerts/gets-a-single-alert-by-id"}]},{"language":"cn","pages":[{"title":"cn","href":"/cn/api-reference/alerts/gets-a-single-alert-by-id"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/api-reference/alerts/gets-a-single-alert-by-id"}]}]},"title":"Gets a single alert by id. - Gorelo Documentation","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CBCH2P7b.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}