{
"message": "The monitors:write permission is required to perform this action."
}
{
"message": "Record not found."
}
Authorizations
Authorization
string
header
required
Use a user token to access authenticated routes. The token must be specified in the Authorization HTTP header with the following format 'Authorization: Bearer '.
Scopes
monitors:read
Headers
X-Phare-Project-Id
integer
A project header is required when using an organization-scoped API key.
Example:
1
X-Phare-Project-Slug
string
A project header is required when using an organization-scoped API key.
Example:
"luminous-guiding-tower"
Path Parameters
monitorId
integer
required
ID of the monitor to show
Response
Success, monitor retrieved
name
string
required
Monitor name
Required string length: 2 - 45
Example:
"Website"
protocol
enum<string>
required
Monitoring protocol
Available options:
http,
tcp,
icmp
request
HTTP protocol · object
required
Monitoring request, depends of the chosen protocol
HTTP protocol
TCP protocol
ICMP protocol
Show child attributes
regions
enum<string>[]
required
List of regions where monitoring checks are performed
Required array length: 1 - 10 elements
Available options:
as-jpn-hnd,
as-sgp-sin,
as-tha-bkk,
eu-deu-fra,
eu-fra-cdg,
eu-gbr-lhr,
eu-swe-arn,
ng-nld-ams,
na-mex-mex,
na-usa-iad,
na-usa-sea,
oc-aus-syd,
sa-bra-gru
id
integer
Monitor ID
Example:
1
project_id
integer
Parent project ID
Example:
1
status
enum<string>
Monitor current status
Available options:
fetching,
online,
offline,
partial,
paused
paused
boolean
Whether the monitor is currently paused
Example:
true
response_time
integer | null
75th percentile (P75) response time of successful checks over the last 7 days, in milliseconds
Example:
123
display_name
string | null
Public name of the monitor on status pages, defaults to the monitor name
Required for the HTTP protocol, with at least one assertion, and ignored for the TCP and ICMP protocols. A check is successful when all its assertions are true.
Status code assertion
Response header assertion
Response body assertion
Show child attributes
incident_confirmations
enum<integer>
default:3
Number of uninterrupted failed checks required to create an incident
Available options:
1,
2,
3,
4,
5
Example:
1
recovery_confirmations
enum<integer>
default:3
Number of uninterrupted successful checks required to resolve an incident
Available options:
1,
2,
3,
4,
5
Example:
1
region_threshold
integer
default:1
Number of regions that must fail before an incident is confirmed, cannot exceed the number of selected regions
Required range: 1 <= x <= 10
Example:
1
tags
string[] | null
Resource tags, made of lowercase letters, numbers, ., _, : and -. An organization can have up to 200 tags.
Maximum array length: 20
Required string length: 1 - 100
last_checked_at
string<date-time> | null
Date of the last performed check with a 30s accuracy
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Phare Documentation","colors":{"primary":"#000000","light":"#FFFFFF","dark":"#000000"},"logo":{"light":"https://mintcdn.com/phare/hFWebKxL68dHFcw7/images/phare.svg?fit=max\u0026auto=format\u0026n=hFWebKxL68dHFcw7\u0026q=85\u0026s=5a0be52167c83deff719654a2c6843cf","dark":"https://mintcdn.com/phare/hFWebKxL68dHFcw7/images/phare.svg?fit=max\u0026auto=format\u0026n=hFWebKxL68dHFcw7\u0026q=85\u0026s=5a0be52167c83deff719654a2c6843cf","href":"https://phare.io"},"favicon":"https://mintcdn.com/phare/fzCvvHJOL_TypLyp/favicon.svg?fit=max\u0026auto=format\u0026n=fzCvvHJOL_TypLyp\u0026q=85\u0026s=91acc855cd0969cfb6612176d4bcd88f","api":{"openapi":["openapi.json"]},"background":{"color":{"light":"#fafaf9"}},"navbar":{"links":[{"href":"mailto:support@phare.io","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.phare.io/login"}},"footer":{"socials":{"github":"https://github.com/phare","linkedin":"https://www.linkedin.com/company/usephare"}},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"phare","hasAudioNarration":false,"actualSubdomain":"phare","customDomains":["docs.phare.io"],"gitSource":{"type":"github","owner":"phare","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6afb8bfa603ac15a57d8a585","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API Reference","count":52},{"language":"default","tag":"Uptime","count":40},{"language":"default","tag":"Documentation","count":26},{"language":"default","tag":"Platform","count":22},{"language":"default","tag":"Integrations","count":15},{"language":"default","tag":"Incidents","count":11},{"language":"default","tag":"Alert rules","count":10},{"language":"default","tag":"Monitors","count":8},{"language":"default","tag":"Maintenance Windows","count":7},{"language":"default","tag":"Status Pages","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"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":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html .frame{padding:0;border:2px solid #000;border-radius:0.25rem}html.dark .frame{border-color:rgb(255 255 255 / 0.3)}html .frame :not(button){border-radius:0}html .frame iframe[src*=\"mediadelivery.net\"]{width:100%!important;height:auto!important;aspect-ratio:3 / 2!important}html .frame>.pointer-events-none{display:none}html .card{border-radius:0.25rem}html:not(.dark) .card{background-color:color-mix(in oklab, oklch(97% 0.001 106.424), oklch(92.3% 0.003 48.717));border:0!important}html.dark img[src*=\"/images/integrations/mcp/mcp.svg\"]{filter:invert(1)}"}],"page":{"pagePath":"api-reference/uptime/monitors/get-a-monitor","slug":"/api-reference/uptime/monitors/get-a-monitor","pageMetadata":{"openapi":"get /uptime/monitors/{monitorId}","title":"Get a monitor","description":"Get a monitor by ID, with its current status, response time, request settings and check regions.\n\nRequires the `monitors:read` permission.","href":"/api-reference/uptime/monitors/get-a-monitor"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, 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(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Get a monitor by ID, with its current status, response time, request settings and check regions.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Requires the \", _jsx(_components.code, {\n children: \"monitors:read\"\n }), \" permission.\"]\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":{"openapi":"get /uptime/monitors/{monitorId}","title":"Get a monitor","description":"Get a monitor by ID, with its current status, response time, request settings and check regions.\n\nRequires the `monitors:read` permission.","href":"/api-reference/uptime/monitors/get-a-monitor"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Monitors"],"summary":"Get a monitor","description":"Get a monitor by ID, with its current status, response time, request settings and check regions.\n\nRequires the `monitors:read` permission.","operationId":"getUptimeMonitor","parameters":["21caaba0-dd4e-41b0-877f-7e0d8d033148","ac889fdf-c6bf-44fe-b828-170e475fd4b1","8784c7c9-1e21-42f9-8e6b-c2058cf72a1e"],"responses":{"200":"0660ded8-d826-4ee4-b7fd-f205226338cf","401":"1d3ac9f4-7547-4e3f-90c7-460f7cfec007","403":"9163c015-4268-4c4d-95e8-a81386e9e0f3","404":"e80918a7-139e-4444-8ef8-1274475f409c"},"security":["845367f6-c1fc-46fc-9a13-7b521d5d53b2"],"method":"get","type":"path","servers":["fccc5af7-5b56-4bd7-b6c4-483e42244e80"],"path":"/uptime/monitors/{monitorId}","baseUrlOptions":["https://api.phare.io"],"title":"Get a monitor","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"21caaba0-dd4e-41b0-877f-7e0d8d033148":{"name":"monitorId","in":"path","description":"ID of the monitor to show","required":true,"schema":{"type":"integer","isRequired":true,"description":"ID of the monitor to show","uniqueKey":"","typeLabel":"integer"}},"ac889fdf-c6bf-44fe-b828-170e475fd4b1":{"name":"X-Phare-Project-Id","in":"header","description":"A project header is required when using an organization-scoped API key.","required":false,"schema":{"type":"integer","example":1,"isRequired":false,"description":"A project header is required when using an organization-scoped API key.","uniqueKey":"","typeLabel":"integer"}},"8784c7c9-1e21-42f9-8e6b-c2058cf72a1e":{"name":"X-Phare-Project-Slug","in":"header","description":"A project header is required when using an organization-scoped API key.","required":false,"schema":{"type":"string","example":"luminous-guiding-tower","isRequired":false,"description":"A project header is required when using an organization-scoped API key.","uniqueKey":"","typeLabel":"string"}}},"responses":{"0660ded8-d826-4ee4-b7fd-f205226338cf":{"description":"Success, monitor retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"Monitor name","type":"string","example":"Website","maxLength":45,"minLength":2,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"protocol":{"type":"string","enum":["http","tcp","icmp"],"description":"Monitoring protocol","isRequired":true,"uniqueKey":"protocol","typeLabel":"enum\u003cstring>"},"request":{"oneOf":[{"type":"object","title":"HTTP protocol","description":"Monitoring request, depends of the chosen protocol","required":["method","url"],"properties":{"method":{"description":"HTTP request method","type":"string","enum":["HEAD","GET","POST","PUT","PATCH","OPTIONS"],"isRequired":true,"uniqueKey":"request.oneOf.0.method","typeLabel":"enum\u003cstring>"},"url":{"description":"HTTP request url","type":"string","example":"https://docs.phare.io/introduction","maxLength":255,"isRequired":true,"uniqueKey":"request.oneOf.0.url","typeLabel":"string"},"tls_skip_verify":{"oneOf":[{"description":"Skip SSL verification","type":"boolean","example":false,"default":false,"uniqueKey":"request.oneOf.0.tls_skip_verify.oneOf.0","typeLabel":"boolean"},{"description":"Skip SSL verification","type":"null","example":false,"default":false,"uniqueKey":"request.oneOf.0.tls_skip_verify.oneOf.1","typeLabel":"null"}],"uniqueKey":"request.oneOf.0.tls_skip_verify","typeLabel":"boolean | null"},"body":{"oneOf":[{"description":"HTTP request body for POST, PUT and PATCH requests","type":"string","example":"Hello, World!","maxLength":500,"uniqueKey":"request.oneOf.0.body.oneOf.0","typeLabel":"string"},{"description":"HTTP request body for POST, PUT and PATCH requests","type":"null","example":"Hello, World!","maxLength":500,"uniqueKey":"request.oneOf.0.body.oneOf.1","typeLabel":"null"}],"uniqueKey":"request.oneOf.0.body","typeLabel":"string | null"},"follow_redirects":{"oneOf":[{"description":"Follow redirects","type":"boolean","example":true,"default":true,"uniqueKey":"request.oneOf.0.follow_redirects.oneOf.0","typeLabel":"boolean"},{"description":"Follow redirects","type":"null","example":true,"default":true,"uniqueKey":"request.oneOf.0.follow_redirects.oneOf.1","typeLabel":"null"}],"uniqueKey":"request.oneOf.0.follow_redirects","typeLabel":"boolean | null"},"user_agent_secret_enabled":{"description":"Whether a user agent secret is set","type":"boolean","readOnly":true,"example":true,"uniqueKey":"request.oneOf.0.user_agent_secret_enabled","typeLabel":"boolean"},"headers":{"oneOf":[{"description":"Additional HTTP headers to add to the request","type":"array","items":{"required":["name"],"properties":{"name":{"description":"Header name, unique per request, the User-Agent, Signature, Signature-Input and Signature-Agent headers are not allowed","type":"string","example":"X-Phare-Says","maxLength":50,"isRequired":true,"uniqueKey":"request.oneOf.0.headers.oneOf.0.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Header value, always required on create. A secret header value is never returned, so on update it is only optional for a secret header that is already set: without it, the header keeps its current value, matched by name.","type":"string","example":"Hello world!","maxLength":1024,"uniqueKey":"request.oneOf.0.headers.oneOf.0.items.[INDEX].value","typeLabel":"string"},"secret":{"description":"Whether the header value is a secret, encrypted and never returned. False for a new header, an update without it keeps the current flag of the header with the same name.","type":"boolean","example":false,"uniqueKey":"request.oneOf.0.headers.oneOf.0.items.[INDEX].secret","typeLabel":"boolean"}},"type":"object","uniqueKey":"request.oneOf.0.headers.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":10,"uniqueKey":"request.oneOf.0.headers.oneOf.0","typeLabel":"object[]"},{"description":"Additional HTTP headers to add to the request","type":"null","items":{"required":["name"],"properties":{"name":{"description":"Header name, unique per request, the User-Agent, Signature, Signature-Input and Signature-Agent headers are not allowed","type":"string","example":"X-Phare-Says","maxLength":50},"value":{"description":"Header value, always required on create. A secret header value is never returned, so on update it is only optional for a secret header that is already set: without it, the header keeps its current value, matched by name.","type":"string","example":"Hello world!","maxLength":1024},"secret":{"description":"Whether the header value is a secret, encrypted and never returned. False for a new header, an update without it keeps the current flag of the header with the same name.","type":"boolean","example":false}},"type":"object"},"maxItems":10,"uniqueKey":"request.oneOf.0.headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"request.oneOf.0.headers","typeLabel":"object[] | null"}},"isRequired":true,"uniqueKey":"request.oneOf.0","typeLabel":"HTTP protocol · object"},{"type":"object","title":"TCP protocol","description":"Monitoring request, depends of the chosen protocol","required":["host","port","connection"],"properties":{"host":{"description":"TCP request hostname or IP address","type":"string","example":"8.8.8.8","isRequired":true,"uniqueKey":"request.oneOf.1.host","typeLabel":"string"},"port":{"description":"TCP request port, between 1 and 65535","type":"string","example":"80","isRequired":true,"uniqueKey":"request.oneOf.1.port","typeLabel":"string"},"connection":{"type":"string","enum":["plain","tls"],"description":"Connection type for TCP protocol","isRequired":true,"uniqueKey":"request.oneOf.1.connection","typeLabel":"enum\u003cstring>"},"tls_skip_verify":{"oneOf":[{"description":"Skip TLS verification","type":"boolean","example":false,"default":false,"uniqueKey":"request.oneOf.1.tls_skip_verify.oneOf.0","typeLabel":"boolean"},{"description":"Skip TLS verification","type":"null","example":false,"default":false,"uniqueKey":"request.oneOf.1.tls_skip_verify.oneOf.1","typeLabel":"null"}],"uniqueKey":"request.oneOf.1.tls_skip_verify","typeLabel":"boolean | null"}},"isRequired":true,"uniqueKey":"request.oneOf.1","typeLabel":"TCP protocol · object"},{"type":"object","title":"ICMP protocol","description":"Monitoring request, depends of the chosen protocol","required":["host"],"properties":{"host":{"description":"ICMP request hostname or IP address","type":"string","example":"8.8.8.8","isRequired":true,"uniqueKey":"request.oneOf.2.host","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"request.oneOf.2","typeLabel":"ICMP protocol · object"}],"isRequired":true,"uniqueKey":"request","typeLabel":"HTTP protocol · object | TCP protocol · object | ICMP protocol · object"},"regions":{"description":"List of regions where monitoring checks are performed","type":"array","items":{"type":"string","enum":["as-jpn-hnd","as-sgp-sin","as-tha-bkk","eu-deu-fra","eu-fra-cdg","eu-gbr-lhr","eu-swe-arn","ng-nld-ams","na-mex-mex","na-usa-iad","na-usa-sea","oc-aus-syd","sa-bra-gru"],"uniqueKey":"regions.items.[INDEX]","typeLabel":"enum\u003cstring>"},"maxItems":10,"minItems":1,"isRequired":true,"uniqueKey":"regions","typeLabel":"enum\u003cstring>[]"},"id":{"description":"Monitor ID","type":"integer","example":1,"uniqueKey":"id","typeLabel":"integer"},"project_id":{"description":"Parent project ID","type":"integer","example":1,"uniqueKey":"project_id","typeLabel":"integer"},"status":{"type":"string","enum":["fetching","online","offline","partial","paused"],"description":"Monitor current status","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"paused":{"description":"Whether the monitor is currently paused","type":"boolean","example":true,"uniqueKey":"paused","typeLabel":"boolean"},"response_time":{"oneOf":[{"description":"75th percentile (P75) response time of successful checks over the last 7 days, in milliseconds","type":"integer","example":123,"uniqueKey":"response_time.oneOf.0","typeLabel":"integer"},{"description":"75th percentile (P75) response time of successful checks over the last 7 days, in milliseconds","type":"null","example":123,"uniqueKey":"response_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_time","typeLabel":"integer | null"},"display_name":{"oneOf":[{"description":"Public name of the monitor on status pages, defaults to the monitor name","type":"string","example":"Website","default":null,"maxLength":45,"minLength":2,"uniqueKey":"display_name.oneOf.0","typeLabel":"string"},{"description":"Public name of the monitor on status pages, defaults to the monitor name","type":"null","example":"Website","default":null,"maxLength":45,"minLength":2,"uniqueKey":"display_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"display_name","typeLabel":"string | null"},"interval":{"description":"Monitoring interval in seconds","type":"integer","example":60,"default":60,"enum":[30,60,120,180,300,600,900,1800,3600],"uniqueKey":"interval","typeLabel":"enum\u003cinteger>"},"timeout":{"description":"Monitoring timeout in milliseconds","type":"integer","example":20000,"default":20000,"enum":[1000,2000,3000,4000,5000,6000,7000,8000,9000,10000,15000,20000,25000,30000],"uniqueKey":"timeout","typeLabel":"enum\u003cinteger>"},"success_assertions":{"description":"Required for the HTTP protocol, with at least one assertion, and ignored for the TCP and ICMP protocols. A check is successful when all its assertions are true.","type":"array","items":{"oneOf":[{"type":"object","title":"Status code assertion","required":["type","operator","value"],"properties":{"type":{"description":"Type of assertion, only one status code assertion is allowed","type":"string","enum":["status_code"],"isRequired":true,"uniqueKey":"success_assertions.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"operator":{"description":"Operator to use for the assertion","type":"string","example":"in","enum":["in","not_in"],"isRequired":true,"uniqueKey":"success_assertions.items.[INDEX].oneOf.0.operator","typeLabel":"enum\u003cstring>"},"value":{"description":"A comma-separated list of status code values, you can use x as a wildcard for any digit.","type":"string","example":"2xx,30x,418","maxLength":150,"minLength":3,"isRequired":true,"uniqueKey":"success_assertions.items.[INDEX].oneOf.0.value","typeLabel":"string"}},"uniqueKey":"success_assertions.items.[INDEX].oneOf.0","typeLabel":"Status code assertion · object"},{"type":"object","title":"Response header assertion","required":["type","selector","operator","value"],"properties":{"type":{"description":"Type of assertion","type":"string","enum":["response_header"],"isRequired":true,"uniqueKey":"success_assertions.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"selector":{"description":"The name of the header to assert","type":"string","example":"Content-Type","maxLength":100,"isRequired":true,"uniqueKey":"success_assertions.items.[INDEX].oneOf.1.selector","typeLabel":"string"},"operator":{"description":"Operator to use for the assertion","type":"string","example":"equals","enum":["equals","not_equals"],"isRequired":true,"uniqueKey":"success_assertions.items.[INDEX].oneOf.1.operator","typeLabel":"enum\u003cstring>"},"value":{"description":"The value of the header to assert","type":"string","example":"application/json","maxLength":150,"minLength":1,"isRequired":true,"uniqueKey":"success_assertions.items.[INDEX].oneOf.1.value","typeLabel":"string"}},"uniqueKey":"success_assertions.items.[INDEX].oneOf.1","typeLabel":"Response header assertion · object"},{"type":"object","title":"Response body assertion","required":["type","operator","value"],"properties":{"type":{"description":"Type of assertion, not available for HEAD and OPTIONS requests","type":"string","enum":["response_body"],"isRequired":true,"uniqueKey":"success_assertions.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"operator":{"description":"Operator to use for the assertion","type":"string","example":"contains","enum":["contains","not_contains"],"isRequired":true,"uniqueKey":"success_assertions.items.[INDEX].oneOf.2.operator","typeLabel":"enum\u003cstring>"},"value":{"description":"A word or sentence to check in the response body","type":"string","example":"Hello, World!","maxLength":150,"minLength":1,"isRequired":true,"uniqueKey":"success_assertions.items.[INDEX].oneOf.2.value","typeLabel":"string"}},"uniqueKey":"success_assertions.items.[INDEX].oneOf.2","typeLabel":"Response body assertion · object"}],"uniqueKey":"success_assertions.items.[INDEX]","typeLabel":"Status code assertion · object | Response header assertion · object | Response body assertion · object"},"uniqueKey":"success_assertions","typeLabel":"(Status code assertion · object | Response header assertion · object | Response body assertion · object)[]"},"incident_confirmations":{"description":"Number of uninterrupted failed checks required to create an incident","type":"integer","example":1,"default":3,"enum":[1,2,3,4,5],"uniqueKey":"incident_confirmations","typeLabel":"enum\u003cinteger>"},"recovery_confirmations":{"description":"Number of uninterrupted successful checks required to resolve an incident","type":"integer","example":1,"default":3,"enum":[1,2,3,4,5],"uniqueKey":"recovery_confirmations","typeLabel":"enum\u003cinteger>"},"region_threshold":{"description":"Number of regions that must fail before an incident is confirmed, cannot exceed the number of selected regions","type":"integer","example":1,"default":1,"maximum":10,"minimum":1,"uniqueKey":"region_threshold","typeLabel":"integer"},"tags":{"oneOf":[{"description":"Resource tags, made of lowercase letters, numbers, `.`, `_`, `:` and `-`. An organization can have up to 200 tags.","type":"array","items":{"type":"string","example":"environment:production","maxLength":100,"minLength":1,"uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":20,"uniqueKey":"tags.oneOf.0","typeLabel":"string[]"},{"description":"Resource tags, made of lowercase letters, numbers, `.`, `_`, `:` and `-`. An organization can have up to 200 tags.","type":"null","items":{"type":"string","example":"environment:production","maxLength":100,"minLength":1},"maxItems":20,"uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"string[] | null"},"last_checked_at":{"oneOf":[{"description":"Date of the last performed check with a 30s accuracy","type":"string","format":"date-time","uniqueKey":"last_checked_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Date of the last performed check with a 30s accuracy","type":"null","format":"date-time","uniqueKey":"last_checked_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_checked_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"description":"Date of creation for the entity","type":"string","format":"date-time","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Date of last update for the entity","type":"string","format":"date-time","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"required":["name","protocol","request","regions"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"Website","protocol":"http","request":{"method":"HEAD","url":"https://docs.phare.io/introduction","tls_skip_verify":false,"body":"Hello, World!","follow_redirects":true,"user_agent_secret_enabled":true,"headers":[{"name":"X-Phare-Says","value":"Hello world!","secret":false}]},"regions":["as-jpn-hnd"],"id":1,"project_id":1,"status":"fetching","paused":true,"response_time":123,"display_name":"Website","interval":60,"timeout":20000,"success_assertions":[{"type":"status_code","operator":"in","value":"2xx,30x,418"}],"incident_confirmations":1,"recovery_confirmations":1,"region_threshold":1,"tags":["environment:production"],"last_checked_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"1d3ac9f4-7547-4e3f-90c7-460f7cfec007":{"description":"Error, access unauthorized","content":{"application/json":{"schema":{"description":"Access unauthorized error schema","properties":{"message":{"type":"string","example":"Unauthenticated.","uniqueKey":"message","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthenticated."}}},"exampleType":"generated"}},"exampleType":"generated"},"9163c015-4268-4c4d-95e8-a81386e9e0f3":{"description":"Error, access forbidden","content":{"application/json":{"schema":{"description":"Access forbidden error schema","properties":{"message":{"type":"string","example":"The monitors:write permission is required to perform this action.","uniqueKey":"message","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The monitors:write permission is required to perform this action."}}},"exampleType":"generated"}},"exampleType":"generated"},"e80918a7-139e-4444-8ef8-1274475f409c":{"description":"Error, resource not found","content":{"application/json":{"schema":{"description":"Not found error schema","properties":{"message":{"type":"string","example":"Record not found.","uniqueKey":"message","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Record not found."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"845367f6-c1fc-46fc-9a13-7b521d5d53b2":{"BearerAuth":{"type":"http","description":"Use a user token to access authenticated routes. The token must be specified in the Authorization HTTP header with the following format 'Authorization: Bearer \u003ctoken>'.","scheme":"bearer","scopes":["monitors:read"],"schemeName":"BearerAuth"}}},"servers":{"fccc5af7-5b56-4bd7-b6c4-483e42244e80":{"url":"https://api.phare.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Use a user token to access authenticated routes. The token must be specified in the Authorization HTTP header with the following format 'Authorization: Bearer \u003ctoken>'.","scheme":"bearer","scopes":["monitors:read"],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use a user token to access authenticated routes. The token must be specified in the Authorization HTTP header with the following format 'Authorization: Bearer \u003ctoken>'.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"phare","siteName":"Phare Documentation","title":"Get a monitor - Phare Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-08T11:49:24.791Z","gitLastModified":"2026-02-08T18:32:16.000Z","originalFileLocation":"api-reference/uptime/monitors/get-a-monitor.mdx"},"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=\"system\"}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=\"Get a monitor by ID, with its current status, response time, request settings and check regions. Requires the monitors:read permission.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Phare 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/phare/ZvNSF4f4Ppk4Ggnv/_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/phare/ZvNSF4f4Ppk4Ggnv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/phare/ZvNSF4f4Ppk4Ggnv/_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/phare/ZvNSF4f4Ppk4Ggnv/_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/phare/ZvNSF4f4Ppk4Ggnv/_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/phare/ZvNSF4f4Ppk4Ggnv/_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/phare/ZvNSF4f4Ppk4Ggnv/_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/phare/ZvNSF4f4Ppk4Ggnv/_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/phare/ZvNSF4f4Ppk4Ggnv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a monitor - Phare Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a monitor by ID, with its current status, response time, request settings and check regions. Requires the monitors:read permission.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Phare Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.phare.io/api-reference/uptime/monitors/get-a-monitor\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://phare.mintlify.site/_mintlify/api/og/v2?division=Monitors\u0026amp;title=Get+a+monitor\u0026amp;description=Get+a+monitor+by+ID%2C+with+its+current+status%2C+response+time%2C+request+settings+and+check+regions.%0A%0ARequires+the+%60monitors%3Aread%60+permission.\u0026amp;theme=f7a949e05a51a53d25073acc\u0026amp;signature=e2787f6e08ead7ec64f97e412d5379da845e222189bad3b4dc2e4c20b77f1b6b\">\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=\"Get a monitor - Phare Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a monitor by ID, with its current status, response time, request settings and check regions. Requires the monitors:read permission.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://phare.mintlify.site/_mintlify/api/og/v2?division=Monitors\u0026amp;title=Get+a+monitor\u0026amp;description=Get+a+monitor+by+ID%2C+with+its+current+status%2C+response+time%2C+request+settings+and+check+regions.%0A%0ARequires+the+%60monitors%3Aread%60+permission.\u0026amp;theme=f7a949e05a51a53d25073acc\u0026amp;signature=e2787f6e08ead7ec64f97e412d5379da845e222189bad3b4dc2e4c20b77f1b6b\">\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/phare/ZvNSF4f4Ppk4Ggnv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Phare Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.phare.io/api-reference/uptime/monitors/get-a-monitor\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/uptime/monitors/get-a-monitor.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.phare.io/#organization\",\"name\":\"Phare Documentation\",\"url\":\"https://docs.phare.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/phare/hFWebKxL68dHFcw7/images/phare.svg?fit=max\u0026auto=format\u0026n=hFWebKxL68dHFcw7\u0026q=85\u0026s=5a0be52167c83deff719654a2c6843cf\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.phare.io#website\",\"name\":\"Phare Documentation\",\"url\":\"https://docs.phare.io\",\"publisher\":{\"@id\":\"https://docs.phare.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.phare.io/api-reference/uptime/monitors/get-a-monitor#webpage\",\"url\":\"https://docs.phare.io/api-reference/uptime/monitors/get-a-monitor\",\"name\":\"Get a monitor\",\"description\":\"Get a monitor by ID, with its current status, response time, request settings and check regions. Requires the monitors:read permission.\",\"dateModified\":\"2026-02-08T18:32:16.000Z\",\"isPartOf\":{\"@id\":\"https://docs.phare.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.phare.io/api-reference/uptime/monitors/get-a-monitor#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.phare.io/api-reference/uptime/monitors/get-a-monitor#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Uptime\",\"item\":\"https://docs.phare.io/api-reference/uptime/monitors/list-monitors\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Monitors\",\"item\":\"https://docs.phare.io/api-reference/uptime/monitors/list-monitors\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a monitor\",\"item\":\"https://docs.phare.io/api-reference/uptime/monitors/get-a-monitor\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.phare.io/api-reference/uptime/monitors/get-a-monitor#apireference\",\"headline\":\"Get a monitor\",\"name\":\"Get a monitor\",\"description\":\"Get a monitor by ID, with its current status, response time, request settings and check regions. Requires the monitors:read permission.\",\"url\":\"https://docs.phare.io/api-reference/uptime/monitors/get-a-monitor\",\"mainEntityOfPage\":{\"@id\":\"https://docs.phare.io/api-reference/uptime/monitors/get-a-monitor#webpage\"},\"dateModified\":\"2026-02-08T18:32:16.000Z\",\"publisher\":{\"@id\":\"https://docs.phare.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.phare.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Phare Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Phare Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/uptime/monitors/get-a-monitor.md","siteName":"Phare Documentation","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"anchor":"API Reference","icon":"rectangle-terminal","groups":[{"group":"API Documentation","pages":[{"title":"API Introduction","href":"/api-reference/introduction"}]},{"group":"Platform","pages":[{"openapi":"get /","title":"Get API info","href":"/api-reference/platform/get-api-info"},{"group":"Alert Rules","pages":[{"openapi":"get /alert-rules","title":"List alert rules","href":"/api-reference/platform/alert-rules/list-alert-rules"},{"openapi":"post /alert-rules","title":"Create an alert rule","href":"/api-reference/platform/alert-rules/create-an-alert-rule"},{"openapi":"get /alert-rules/{alertRuleId}","title":"Get an alert rule","href":"/api-reference/platform/alert-rules/get-an-alert-rule"},{"openapi":"post /alert-rules/{alertRuleId}","title":"Update an alert rule","href":"/api-reference/platform/alert-rules/update-an-alert-rule"},{"openapi":"delete /alert-rules/{alertRuleId}","title":"Delete an alert rule","href":"/api-reference/platform/alert-rules/delete-an-alert-rule"}]},{"group":"Integrations","pages":[{"openapi":"get /apps/{app}/integrations","title":"List integrations","href":"/api-reference/platform/integrations/list-integrations"},{"openapi":"post /apps/{app}/integrations","title":"Create an integration","href":"/api-reference/platform/integrations/create-an-integration"},{"openapi":"get /apps/{app}/integrations/{integrationId}","title":"Get an integration","href":"/api-reference/platform/integrations/get-an-integration"},{"openapi":"post /apps/{app}/integrations/{integrationId}","title":"Update an integration","href":"/api-reference/platform/integrations/update-an-integration"},{"openapi":"delete /apps/{app}/integrations/{integrationId}","title":"Delete an integration","href":"/api-reference/platform/integrations/delete-an-integration"}]},{"group":"Projects","pages":[{"openapi":"get /projects","title":"List projects","href":"/api-reference/platform/projects/list-projects"},{"openapi":"post /projects","title":"Create a project","href":"/api-reference/platform/projects/create-a-project"},{"openapi":"get /projects/{projectId}","title":"Get a project","href":"/api-reference/platform/projects/get-a-project"},{"openapi":"post /projects/{projectId}","title":"Update a project","href":"/api-reference/platform/projects/update-a-project"},{"openapi":"delete /projects/{projectId}","title":"Delete a project","href":"/api-reference/platform/projects/delete-a-project"}]},{"group":"Users","pages":[{"openapi":"get /users","title":"List users","href":"/api-reference/platform/users/list-users"},{"openapi":"get /users/{userId}","title":"Get a user","href":"/api-reference/platform/users/get-a-user"}]}]},{"group":"Uptime","pages":[{"group":"Monitors","pages":[{"openapi":"get /uptime/monitors","title":"List monitors","description":"Get a paginated list of the monitors of the project, newest first, with their current status and response time. Filter them by tag.\n\nRequires the `monitors:read` permission.","href":"/api-reference/uptime/monitors/list-monitors"},{"openapi":"get /uptime/monitors/{monitorId}","title":"Get a monitor","href":"/api-reference/uptime/monitors/get-a-monitor"},{"openapi":"post /uptime/monitors","title":"Create a monitor","description":"Create an HTTP, TCP or ICMP monitor checking a service at a regular interval from 1 to 10 regions, it opens an incident once the failures are confirmed. The first check runs right away when the organization has monitoring events left in its quota, and the `uptime.monitor.created` alert rules are triggered.\n\nRequires the `monitors:write` permission.","href":"/api-reference/uptime/monitors/create-a-monitor"},{"openapi":"post /uptime/monitors/{monitorId}","title":"Update a monitor","href":"/api-reference/uptime/monitors/update-a-monitor"},{"openapi":"post /uptime/monitors/{monitorId}/pause","title":"Pause a monitor","href":"/api-reference/uptime/monitors/pause-a-monitor"},{"openapi":"post /uptime/monitors/{monitorId}/resume","title":"Resume a monitor","href":"/api-reference/uptime/monitors/resume-a-monitor"},{"openapi":"delete /uptime/monitors/{monitorId}","title":"Delete a monitor","href":"/api-reference/uptime/monitors/delete-a-monitor"},{"openapi":"get /uptime/monitors/{monitorId}/report","title":"Get a monitor report","href":"/api-reference/uptime/monitors/get-a-monitor-report"}]},{"group":"Incidents","pages":[{"openapi":"get /uptime/incidents","title":"List incidents","href":"/api-reference/uptime/incidents/list-incidents"},{"openapi":"get /uptime/incidents/{incidentId}","title":"Get an incident","href":"/api-reference/uptime/incidents/get-an-incident"},{"openapi":"post /uptime/incidents","title":"Create an incident","href":"/api-reference/uptime/incidents/create-an-incident"},{"openapi":"post /uptime/incidents/{incidentId}","title":"Update an incident","href":"/api-reference/uptime/incidents/update-an-incident"},{"openapi":"post /uptime/incidents/{incidentId}/recover","title":"Recover an incident","href":"/api-reference/uptime/incidents/recover-an-incident"},{"openapi":"delete /uptime/incidents/{incidentId}","title":"Delete an incident","href":"/api-reference/uptime/incidents/delete-an-incident"},{"group":"Incident Updates","pages":[{"openapi":"get /uptime/incidents/{incidentId}/updates","title":"List incident updates","href":"/api-reference/uptime/incidents/updates/list-incident-updates"},{"openapi":"get /uptime/incidents/{incidentId}/updates/{incidentUpdateId}","title":"Get an incident update","href":"/api-reference/uptime/incidents/updates/get-an-incident-update"},{"openapi":"post /uptime/incidents/{incidentId}/updates","title":"Create an incident update","href":"/api-reference/uptime/incidents/updates/create-an-incident-update"},{"openapi":"post /uptime/incidents/{incidentId}/updates/{incidentUpdateId}","title":"Update an incident update","href":"/api-reference/uptime/incidents/updates/update-an-incident-update"},{"openapi":"delete /uptime/incidents/{incidentId}/updates/{incidentUpdateId}","title":"Delete an incident update","href":"/api-reference/uptime/incidents/updates/delete-an-incident-update"}]}]},{"group":"Maintenance Windows","pages":[{"openapi":"get /uptime/maintenance-windows","title":"List maintenance windows","href":"/api-reference/uptime/maintenance-windows/list-maintenance-windows"},{"openapi":"get /uptime/maintenance-windows/{maintenanceWindowId}","title":"Get a maintenance window","href":"/api-reference/uptime/maintenance-windows/get-a-maintenance-window"},{"openapi":"post /uptime/maintenance-windows","title":"Create a maintenance window","href":"/api-reference/uptime/maintenance-windows/create-a-maintenance-window"},{"openapi":"post /uptime/maintenance-windows/{maintenanceWindowId}","title":"Update a maintenance window","href":"/api-reference/uptime/maintenance-windows/update-a-maintenance-window"},{"openapi":"post /uptime/maintenance-windows/{maintenanceWindowId}/complete","title":"Complete a maintenance window","href":"/api-reference/uptime/maintenance-windows/complete-a-maintenance-window"},{"openapi":"post /uptime/maintenance-windows/{maintenanceWindowId}/cancel","title":"Cancel a maintenance window","href":"/api-reference/uptime/maintenance-windows/cancel-a-maintenance-window"},{"openapi":"delete /uptime/maintenance-windows/{maintenanceWindowId}","title":"Delete a maintenance window","href":"/api-reference/uptime/maintenance-windows/delete-a-maintenance-window"}]},{"group":"Status Pages","pages":[{"openapi":"get /uptime/status-pages","title":"List status pages","href":"/api-reference/uptime/status-pages/list-status-pages"},{"openapi":"get /uptime/status-pages/{statusPageId}","title":"Get a status page","href":"/api-reference/uptime/status-pages/get-a-status-page"},{"openapi":"post /uptime/status-pages","title":"Create a status page","href":"/api-reference/uptime/status-pages/create-a-status-page"},{"openapi":"post /uptime/status-pages/{statusPageId}","title":"Update a status page","href":"/api-reference/uptime/status-pages/update-a-status-page"},{"openapi":"delete /uptime/status-pages/{statusPageId}","title":"Delete a status page","href":"/api-reference/uptime/status-pages/delete-a-status-page"},{"openapi":"get /uptime/status-pages/{statusPageId}/current-status","title":"Get a status page current status","href":"/api-reference/uptime/status-pages/get-a-status-page-current-status"}]},{"group":"Reports","pages":[{"openapi":"get /uptime/reports","title":"Get report","href":"/api-reference/uptime/reports/get-a-report"}]}]}]},{"anchor":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]},{"anchor":"Blog","icon":"newspaper","href":"https://phare.io/blog/"},{"anchor":"Service status","icon":"tower-cell","href":"https://status.phare.io/"}]},"basePath":"","title":"Get a monitor - Phare Documentation","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}