{"items":[{"type":"link","label":"StatusHub Management API","link":"/api-v3-openapi","routeSlug":"/api-v3-openapi","content":{"contentType":"overview","meta":{"name":"StatusHub Management API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"api-v3-openapi.json","url":"/_bundle/api-v3-openapi.json?download"},{"kind":"download","label":"api-v3-openapi.yaml","url":"/_bundle/api-v3-openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://statushub.com/contact/","url":"https://statushub.com/contact/"},{"kind":"email","title":"StatusHub Support","email":"support@statushub.dev","label":"support@statushub.dev","withCopyButton":true,"copyContent":"support@statushub.dev"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://statushub.com/terms/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account","description":"Unique subdomain of your account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account","description":"Unique subdomain of your account"}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"StatusHub Management API (3.0-R1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/api-v3-openapi"}],"sectionId":"/api-v3-openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/the-statushub-management-api-v3"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The StatusHub Management API v3"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"StatusHub Management API V3 is a REST API intended to be an alternative"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to StatusHub Control Panel web interface."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example use cases:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automation of incidents creation and update,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automation of Hub services management,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automation of creation and deletion of Connected Hubs."},"children":[]}]}]}]}]}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/the-statushub-management-api-v3/previous-api-versions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Previous API versions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"StatusHub Management API V3 replaces the Management API V2 which is now"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deprecated."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Management API V2 documentation has been moved to a new address:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api-v2-docs.statushub.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://api-v2-docs.statushub.com"},"children":[]}]}]}]}]}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/previous-api-versions"}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/previous-api-versions"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/the-statushub-management-api-v3/statushub-regions-and-api-url"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"StatusHub regions and API URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API requests should be made on hostname used to sign in to StatusHub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Control Panel."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example if team members sign in to account on:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://company.app.statushub.io"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then API requests should be made with following prefix:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://company.app.statushub.io/api/v3"},"children":[]}]}]}]}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/statushub-regions-and-api-url"}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/statushub-regions-and-api-url"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/the-statushub-management-api-v3/eu-region"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EU region"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same rule follows for customers using EU region and then"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the example would be:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If team members sign in to account on:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://company.app-eu1.statushub.io"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then API requests should be made with following prefix:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://company.app-eu1.statushub.io/api/v3"},"children":[]}]}]}]}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/eu-region"}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/eu-region"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/the-statushub-management-api-v3/rate-limiting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limiting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"StatusHub API has two rate limits:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET requests - 30 requests per second"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other requests - 5 requests per second"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit is bound to the API Key used for authentication."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the rate limit is exceeded, StatusHub API will respond with:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429 response code"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"error\":\"Too many requests - please retry later\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry-After response header"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In special cases, certain API methods may have different rate limits which will be mentioned in the API method description."},"children":[]}]}]}]}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/rate-limiting"}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/rate-limiting"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/the-statushub-management-api-v3/time-zones"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time zones"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All date/time parameters should be passed in UTC timezone"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"regardless of the default Hub timezone settings."},"children":[]}]}]}]}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/time-zones"}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/time-zones"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/the-statushub-management-api-v3/filtering-events-by-time-range"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering events by time range"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events like Incident or Maintenance events can be filtered by time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"range."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two optional parameters in INDEX endpoints:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering logic is returning those events which period of occurrence"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overlaps with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also, providing just one of range params, still uses the range but with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a default value of not provided one:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Providing just "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" assumes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as far in the future,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Providing just "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" assumes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as far in the past."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not providing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"far in the past and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being far in the future and as a result"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all events are returned by time range filter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Below are few examples to better understand the logic:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maintenance example"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let's assume maintenance that started on 2025-02-01 and finished"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on 2025-02-08."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time=2025-01-01T00:00:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time=2025-02-02T00:00:00Z"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will return the event because there is an overlap of both ranges:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<2025-01-01 00:00:00 UTC, 2025-02-02 00:00:00 UTC> and"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<2025-02-01 00:00:00 UTC, 2025-02-08 00:00:00 UTC> overlap in"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<2025-02-01 00:00:00 UTC, 2025-02-02 00:00:00 UTC>."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open incident example"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let's assume incident that started on 2025-02-01 and hasn't been"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resolved."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time=2025-03-01T00:00:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and not providing end time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will return the event because there is an overlap of both ranges:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<2025-02-01 00:00:00 UTC, far in the future due to incident still being open>"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<2025-03-01 00:00:00 UTC, far in the future due to not providing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overlap in"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"<2025-03-01 00:00:00 UTC, far in the future>."},"children":[]}]}]}]}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/filtering-events-by-time-range"}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/filtering-events-by-time-range"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/the-statushub-management-api-v3/extended-properties"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extended properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"StatusHub API V3 supports extended versions of certain response properties."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default less frequently required fields are returned in basic form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with most common properties but if more information is needed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query parameter can be used."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently StatusHub API V3 supports extending:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incident flags,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incident Update flags,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maintenance event flags,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription flags."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example for Maintenance flags:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request path with basic flags: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v3/hubs/hub-subdomain/maintenances"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request path with extended flags:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v3/hubs/hub-subdomain/maintenances?extend=flags"},"children":[]}]}]}]}]}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/extended-properties"}],"sectionId":"/api-v3-openapi/section/the-statushub-management-api-v3/extended-properties"}]}]}},{"type":"group","label":"The StatusHub Management API v3","link":"/api-v3-openapi/section/the-statushub-management-api-v3","routeSlug":"/api-v3-openapi/section/the-statushub-management-api-v3","items":[{"type":"link","label":"Previous API versions","link":"/api-v3-openapi/section/the-statushub-management-api-v3/previous-api-versions","routeSlug":"/api-v3-openapi/section/the-statushub-management-api-v3/previous-api-versions","content":null},{"type":"link","label":"StatusHub regions and API URL","link":"/api-v3-openapi/section/the-statushub-management-api-v3/statushub-regions-and-api-url","routeSlug":"/api-v3-openapi/section/the-statushub-management-api-v3/statushub-regions-and-api-url","content":null},{"type":"link","label":"EU region","link":"/api-v3-openapi/section/the-statushub-management-api-v3/eu-region","routeSlug":"/api-v3-openapi/section/the-statushub-management-api-v3/eu-region","content":null},{"type":"link","label":"Rate limiting","link":"/api-v3-openapi/section/the-statushub-management-api-v3/rate-limiting","routeSlug":"/api-v3-openapi/section/the-statushub-management-api-v3/rate-limiting","content":null},{"type":"link","label":"Time zones","link":"/api-v3-openapi/section/the-statushub-management-api-v3/time-zones","routeSlug":"/api-v3-openapi/section/the-statushub-management-api-v3/time-zones","content":null},{"type":"link","label":"Filtering events by time range","link":"/api-v3-openapi/section/the-statushub-management-api-v3/filtering-events-by-time-range","routeSlug":"/api-v3-openapi/section/the-statushub-management-api-v3/filtering-events-by-time-range","content":null},{"type":"link","label":"Extended properties","link":"/api-v3-openapi/section/the-statushub-management-api-v3/extended-properties","routeSlug":"/api-v3-openapi/section/the-statushub-management-api-v3/extended-properties","content":null}],"content":null},{"type":"separator","label":"Events","content":null},{"type":"group","label":"Incident","link":"/api-v3-openapi/incident","routeSlug":"/api-v3-openapi/incident","items":[{"label":"Create an Incident","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident/createincident","routeSlug":"/api-v3-openapi/incident/createincident","metadata":{"seo":{"title":"Create an Incident","description":"Creates a new Incident. During creation, first Incident Update for this Incident will also be created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createIncident","name":"Create an Incident","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incidents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Incident","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new Incident. During creation, first Incident Update for this Incident will also be created.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IncidentPayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Creating an incident draft with silent option"]}},"schemaId":"components/schemas/IncidentPayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Creating an incident draft with silent option"],"pointer":"/paths/~1hubs~1{subdomain}~1incidents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/incidents","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IncidentPayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Creating an incident draft with silent option"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/incidents","href":"incident/createincident","openApiOperationId":"createIncident","summary":"Create an Incident"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/IncidentPayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Creating an incident draft with silent option"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IncidentPayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Creating an incident draft with silent option"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}},"schemaId":"schema_0"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Missing required values","paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Start time in future","paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Wrong service IDs"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Missing required values","paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Start time in future","paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Wrong service IDs"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_0","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Missing required values","paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Start time in future","paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Wrong service IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Missing required values","paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Start time in future","paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Wrong service IDs"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident/createincident"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incidents"},{"label":"List Incidents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident/listincidents","routeSlug":"/api-v3-openapi/incident/listincidents","metadata":{"seo":{"title":"List Incidents","description":"Filters and returns Incident records for current Hub with basic info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listIncidents","name":"List Incidents","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incidents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Incidents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Filters and returns Incident records for current Hub with basic info.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_by_me","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - filter events to only those which were created by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"current user,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - filter events to only those which were "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created by current user,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - don't filter events by creator."},"children":[]}]}]}]}]},{"name":"draft","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters events by presence of unpublished Incident Update:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only events containing at least one unpublished (draft)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incident Update,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only events without any unpublished Incident Updates,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return events without filtering by draft status."},"children":[]}]}]}]}]},{"name":"incident_types","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated names of incident types."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters incidents by status of last (including draft) update."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incident_types=monitoring"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incident_types=investigating,identified"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible incident type values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identified"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"investigating"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monitoring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When not set, do not filter incidents by type of last update."},"children":[]}]}]}]},{"name":"published","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter events by status of publication on Hub Page:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only events published on Hub Page,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only events that were not published on Hub Page."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - don't filter events by publication status."},"children":[]}]}]}]}]},{"name":"unconfirmed","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter events by state of the event:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only events were published as unconfirmed on Hub Page,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only events were published as confirmed on Hub Page."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - don't filter events by unconfirmed status."},"children":[]}]}]}]}]},{"name":"archived","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters incidents by archived status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only incidents that were archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only incidents that were not archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return incidents without filtering by archived status."},"children":[]}]}]}]}]},{"name":"deleted","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters incidents by deletion status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only incidents that were deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only incidents that were not deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return incidents without filtering by deleted status."},"children":[]}]}]}]}]},{"name":"sort_prop","in":"query","schemaId":"schema_3","description":"Determines which property results should be sorted by.\n"},{"name":"sort_dir","in":"query","schemaId":"schema_4","description":"Determines sorting direction.\n"},{"name":"period_name","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated period names."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters event by period name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period_name=current"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period_name=past,current"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible period name values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"past"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When not set, do not filter by period."},"children":[]}]}]}]},{"name":"service_ids","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated string of service ids."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters events by at least one affected service, specified in params."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_ids=1,2,3"},"children":[]}]}]}]},{"name":"statuses","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated string of service statuses names."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters events by at least one affected service with specified status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statuses=degraded-performance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statuses=up,down"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible incident type values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"up"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"degraded-performance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"down"},"children":[]}]}]}]}]},{"name":"start_time","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lower limit of the event start time filter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Assumed as far in the past when not provided."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter events to those which period of occurrence (from event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being far in the future for open incidents) overlaps with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" params."},"children":[]}]}]}]},{"name":"end_time","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upper limit of the event end time filter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Assumed as far in the future when not provided."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter events to those which period of occurrence (from event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being far in the future for open incidents) overlaps with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" params."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String that filters events to those containing the search string in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"extend","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which properties should be expanded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Expanded properties contains more detailed information which is less frequently needed in typical usage."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Currently supported only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/incidents","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"created_by_me","in":"query","schemaId":"schema_1"},{"name":"draft","in":"query","schemaId":"schema_2"},{"name":"incident_types","in":"query","schemaId":"components/schemas/components-Name"},{"name":"published","in":"query","schemaId":"schema_1"},{"name":"unconfirmed","in":"query","schemaId":"schema_1"},{"name":"archived","in":"query","schemaId":"schema_2"},{"name":"deleted","in":"query","schemaId":"schema_2"},{"name":"sort_prop","in":"query","schemaId":"schema_3"},{"name":"sort_dir","in":"query","schemaId":"schema_4"},{"name":"period_name","in":"query","schemaId":"components/schemas/components-Name"},{"name":"service_ids","in":"query","schemaId":"components/schemas/components-Name"},{"name":"statuses","in":"query","schemaId":"components/schemas/components-Name"},{"name":"start_time","in":"query","schemaId":"schema_5"},{"name":"end_time","in":"query","schemaId":"schema_6"},{"name":"q","in":"query","schemaId":"components/schemas/components-Name"},{"name":"extend","in":"query","example":"flags","schemaId":"schema_7"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/incidents","href":"incident/listincidents","openApiOperationId":"listIncidents","summary":"List Incidents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}},"schemaId":"schema_10"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1incidents/get/responses/422/content/application~1json/examples/Invalid extend param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1incidents/get/responses/422/content/application~1json/examples/Invalid extend param"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_10","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1incidents/get/responses/422/content/application~1json/examples/Invalid extend param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1incidents/get/responses/422/content/application~1json/examples/Invalid extend param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident/listincidents"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incidents"},{"label":"Retrieve an Incident","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident/getincident","routeSlug":"/api-v3-openapi/incident/getincident","metadata":{"seo":{"title":"Retrieve an Incident","description":"Returns data about single Incident."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIncident","name":"Retrieve an Incident","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an Incident","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about single Incident."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"incident_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested incident."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"extend","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which properties should be expanded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Expanded properties contains more detailed information which is less frequently needed in typical usage."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Currently supported only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/incidents/{incident_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"incident_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"extend","in":"query","example":"flags","schemaId":"schema_7"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/incidents/{incident_id}","href":"incident/getincident","openApiOperationId":"getIncident","summary":"Retrieve an Incident"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}},"schemaId":"schema_0"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/404/content/application~1json/examples/Invalid incident_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/404/content/application~1json/examples/Invalid incident_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_0","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_0"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/404/content/application~1json/examples/Invalid incident_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/404/content/application~1json/examples/Invalid incident_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/422/content/application~1json/examples/Invalid extend param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident/getincident"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incidents/{incident_id}"},{"label":"Delete an Incident","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident/deleteincident","routeSlug":"/api-v3-openapi/incident/deleteincident","metadata":{"seo":{"title":"Delete an Incident","description":"Deletes Incident record. Records are soft-deleted which means that such deleted record can still be viewed or potentially restored."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteIncident","name":"Delete an Incident","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an Incident","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes Incident record. Records are soft-deleted which means that such deleted record can still be viewed or potentially restored.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"incident_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested incident."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hubs/{subdomain}/incidents/{incident_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"incident_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/incidents/{incident_id}","href":"incident/deleteincident","openApiOperationId":"deleteIncident","summary":"Delete an Incident"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/200/content/application~1json/examples/OK"]}},"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/200/content/application~1json/examples/OK"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/200/content/application~1json/examples/OK"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/200/content/application~1json/examples/OK"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident/deleteincident"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incidents/{incident_id}"}],"content":{"contentType":"group","meta":{"name":"Incident"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Incident","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incident is a most important event type."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incident represents an event that:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Started in the past,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have updates which can be added while incident is being handled,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"During creation and during its duration the total duration or end"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the incident is not known,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is resolved when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Incident Update is created"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for this incident,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have non-0 duration. This means that Incident can't be created"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" incident type."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most typical use case:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub Page list various customer-facing services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When one of the services has an outage, Incident is created manually"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or through automation,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While team is working on restoring the service Incident Update entries"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are added manually or through automation to this incident to let"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customers know what's happening,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once issue is resolved, Incident Update with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"monitoring"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" incident type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is being created while team is keeping an eye on service health,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once situation is stable, Incident Update with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" incident type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is being created which ends the Incident."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/incidents","summary":"Create an Incident","prefix":{"name":"post","color":"post"},"badges":[],"link":"/incident/createincident","deprecated":false},{"title":"/hubs/{subdomain}/incidents","summary":"List Incidents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/incident/listincidents","deprecated":false},{"title":"/hubs/{subdomain}/incidents/{incident_id}","summary":"Retrieve an Incident","prefix":{"name":"get","color":"get"},"badges":[],"link":"/incident/getincident","deprecated":false},{"title":"/hubs/{subdomain}/incidents/{incident_id}","summary":"Delete an Incident","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/incident/deleteincident","deprecated":false}]}]}]}]}},{"type":"group","label":"Incident Update","link":"/api-v3-openapi/incident-update","routeSlug":"/api-v3-openapi/incident-update","items":[{"label":"Create an Incident Update","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident-update/createincidentincidentupdate","routeSlug":"/api-v3-openapi/incident-update/createincidentincidentupdate","metadata":{"seo":{"title":"Create an Incident Update","description":"Creates a new Incident Update. Incident Update is a distinct update in an Incident. Creation of Incident Update records is a way to add new update to an existing Incident."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createIncidentIncidentUpdate","name":"Create an Incident Update","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Incident Update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Incident Update is a distinct update in an Incident. Creation of Incident Update records is a way to add new update to an existing Incident."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"incident_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested incident."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IncidentUpdateCreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Resolving incident"]}},"schemaId":"components/schemas/IncidentUpdateCreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Resolving incident"],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"incident_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IncidentUpdateCreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Resolving incident"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates","href":"incident-update/createincidentincidentupdate","openApiOperationId":"createIncidentIncidentUpdate","summary":"Create an Incident Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/IncidentUpdateCreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Resolving incident"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IncidentUpdateCreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Resolving incident"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}},"schemaId":"schema_13"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/404/content/application~1json/examples/Invalid incident_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/404/content/application~1json/examples/Invalid incident_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Missing required values","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Start time in future","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Wrong service IDs"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Missing required values","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Start time in future","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Wrong service IDs"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_13","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/404/content/application~1json/examples/Invalid incident_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/404/content/application~1json/examples/Invalid incident_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Missing required values","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Start time in future","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Wrong service IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Missing required values","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Start time in future","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Wrong service IDs"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident-update/createincidentincidentupdate"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates"},{"label":"List Incident Updates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident-update/listincidentincidentupdates","routeSlug":"/api-v3-openapi/incident-update/listincidentincidentupdates","metadata":{"seo":{"title":"List Incident Updates","description":"Filters and returns Incident Update records for specific Incident and current Hub with basic info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listIncidentIncidentUpdates","name":"List Incident Updates","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Incident Updates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Filters and returns Incident Update records for specific Incident and current Hub with basic info.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"incident_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested incident."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"archived","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters incident updates by archived status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only incident updates that were archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only incident updates that were not archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return incident updates without filtering by archived status."},"children":[]}]}]}]}]},{"name":"q","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String that filters events to those containing the search string in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"extend","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which properties should be expanded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Expanded properties contains more detailed information which is less frequently needed in typical usage."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Currently supported only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort_prop","in":"query","schemaId":"schema_14","description":"Determines which property results should be sorted by."},{"name":"sort_dir","in":"query","schemaId":"schema_4","description":"Determines sorting direction."},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"incident_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"archived","in":"query","schemaId":"schema_2"},{"name":"q","in":"query","schemaId":"components/schemas/components-Name"},{"name":"extend","in":"query","example":"flags","schemaId":"schema_7"},{"name":"sort_prop","in":"query","schemaId":"schema_14"},{"name":"sort_dir","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates","href":"incident-update/listincidentincidentupdates","openApiOperationId":"listIncidentIncidentUpdates","summary":"List Incident Updates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15"}},"schemaId":"schema_15"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/404/content/application~1json/examples/Invalid incident_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/404/content/application~1json/examples/Invalid incident_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/422/content/application~1json/examples/Invalid extend param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/422/content/application~1json/examples/Invalid extend param"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_15","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/404/content/application~1json/examples/Invalid incident_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/404/content/application~1json/examples/Invalid incident_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/422/content/application~1json/examples/Invalid extend param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/422/content/application~1json/examples/Invalid extend param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident-update/listincidentincidentupdates"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates"},{"label":"Retrieve an Incident Update","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident-update/getincidentincidentupdate","routeSlug":"/api-v3-openapi/incident-update/getincidentincidentupdate","metadata":{"seo":{"title":"Retrieve an Incident Update","description":"Returns data about single Incident Update event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIncidentIncidentUpdate","name":"Retrieve an Incident Update","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an Incident Update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about single Incident Update event."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"incident_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested incident."},"children":[]}]}]}],"required":true},{"name":"incident_update_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested incident update"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"extend","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which properties should be expanded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Expanded properties contains more detailed information which is less frequently needed in typical usage."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Currently supported only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates/{incident_update_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"incident_id","in":"path","required":true,"schemaId":"schema_11"},{"name":"incident_update_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"extend","in":"query","example":"flags","schemaId":"schema_7"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates/{incident_update_id}","href":"incident-update/getincidentincidentupdate","openApiOperationId":"getIncidentIncidentUpdate","summary":"Retrieve an Incident Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}},"schemaId":"schema_13"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid incident_id","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid incident_update_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid incident_id","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid incident_update_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_13","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid incident_id","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid incident_update_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid incident_id","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid incident_update_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/422/content/application~1json/examples/Invalid extend param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident-update/getincidentincidentupdate"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates/{incident_update_id}"},{"label":"Update an Incident Update","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident-update/updateincidentincidentupdate","routeSlug":"/api-v3-openapi/incident-update/updateincidentincidentupdate","metadata":{"seo":{"title":"Update an Incident Update","description":"Modifies existing Incident Update. Only modified attributes may be passed in payload. All other attributes will remain unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateIncidentIncidentUpdate","name":"Update an Incident Update","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an Incident Update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies existing Incident Update. Only modified attributes may be passed in payload. All other attributes will remain unchanged."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"incident_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested incident."},"children":[]}]}]}],"required":true},{"name":"incident_update_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested incident update"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IncidentUpdateUpdatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Update message","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Publish draft"]}},"schemaId":"components/schemas/IncidentUpdateUpdatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Update message","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Publish draft"],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates/{incident_update_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"incident_id","in":"path","required":true,"schemaId":"schema_11"},{"name":"incident_update_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IncidentUpdateUpdatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Update message","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Publish draft"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates/{incident_update_id}","href":"incident-update/updateincidentincidentupdate","openApiOperationId":"updateIncidentIncidentUpdate","summary":"Update an Incident Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/IncidentUpdateUpdatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Update message","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Publish draft"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IncidentUpdateUpdatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Update message","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Publish draft"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}},"schemaId":"schema_13"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid incident_id","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid incident_update_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid incident_id","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid incident_update_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/422/content/application~1json/examples/Start time in future","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/422/content/application~1json/examples/Wrong service IDs"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/422/content/application~1json/examples/Start time in future","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/422/content/application~1json/examples/Wrong service IDs"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_13","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid incident_id","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid incident_update_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid incident_id","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid incident_update_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/422/content/application~1json/examples/Start time in future","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/422/content/application~1json/examples/Wrong service IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/422/content/application~1json/examples/Start time in future","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/422/content/application~1json/examples/Wrong service IDs"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident-update/updateincidentincidentupdate"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates/{incident_update_id}"},{"label":"Delete an Incident Update","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident-update/deleteincidentincidentupdate","routeSlug":"/api-v3-openapi/incident-update/deleteincidentincidentupdate","metadata":{"seo":{"title":"Delete an Incident Update","description":"Deletes Incident Update record. Records are soft-deleted which means that such deleted record can still be viewed or potentially restored."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteIncidentIncidentUpdate","name":"Delete an Incident Update","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an Incident Update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes Incident Update record. Records are soft-deleted which means that such deleted record can still be viewed or potentially restored.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"incident_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested incident."},"children":[]}]}]}],"required":true},{"name":"incident_update_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested incident update"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates/{incident_update_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"incident_id","in":"path","required":true,"schemaId":"schema_11"},{"name":"incident_update_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates/{incident_update_id}","href":"incident-update/deleteincidentincidentupdate","openApiOperationId":"deleteIncidentIncidentUpdate","summary":"Delete an Incident Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/200/content/application~1json/examples/OK"]}},"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/200/content/application~1json/examples/OK"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid incident_update_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid incident_update_id"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/200/content/application~1json/examples/OK"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/200/content/application~1json/examples/OK"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid incident_update_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id","paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid incident_update_id"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident-update/deleteincidentincidentupdate"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates/{incident_update_id}"}],"content":{"contentType":"group","meta":{"name":"Incident Update"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Incident Update","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incident Update represents single update for Incident."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every Incident consists of at least one Incident Update and a resolved"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"incident consists of at least two Incident Updates where the second"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" incident type."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates","summary":"Create an Incident Update","prefix":{"name":"post","color":"post"},"badges":[],"link":"/incident-update/createincidentincidentupdate","deprecated":false},{"title":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates","summary":"List Incident Updates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/incident-update/listincidentincidentupdates","deprecated":false},{"title":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates/{incident_update_id}","summary":"Retrieve an Incident Update","prefix":{"name":"get","color":"get"},"badges":[],"link":"/incident-update/getincidentincidentupdate","deprecated":false},{"title":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates/{incident_update_id}","summary":"Update an Incident Update","prefix":{"name":"put","color":"put"},"badges":[],"link":"/incident-update/updateincidentincidentupdate","deprecated":false},{"title":"/hubs/{subdomain}/incidents/{incident_id}/incident_updates/{incident_update_id}","summary":"Delete an Incident Update","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/incident-update/deleteincidentincidentupdate","deprecated":false}]}]}]}]}},{"type":"group","label":"Maintenance","link":"/api-v3-openapi/maintenance","routeSlug":"/api-v3-openapi/maintenance","items":[{"label":"Create a Maintenance event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/maintenance/createmaintenance","routeSlug":"/api-v3-openapi/maintenance/createmaintenance","metadata":{"seo":{"title":"Create a Maintenance event","description":"Creates a new Maintenance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMaintenance","name":"Create a Maintenance event","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1maintenances/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Maintenance event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new Maintenance."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MaintenancePayload","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Creating a recurring maintenance repeating every month"]}},"schemaId":"components/schemas/MaintenancePayload","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Creating a recurring maintenance repeating every month"],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/maintenances","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MaintenancePayload","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Creating a recurring maintenance repeating every month"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/maintenances","href":"maintenance/createmaintenance","openApiOperationId":"createMaintenance","summary":"Create a Maintenance event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/MaintenancePayload","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Creating a recurring maintenance repeating every month"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MaintenancePayload","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Basic example","paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Creating a recurring maintenance repeating every month"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/422/content/application~1json/examples/Missing required values","paths/~1hubs~1{subdomain}~1maintenances/post/responses/422/content/application~1json/examples/Wrong service IDs"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/422/content/application~1json/examples/Missing required values","paths/~1hubs~1{subdomain}~1maintenances/post/responses/422/content/application~1json/examples/Wrong service IDs"]}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/422/content/application~1json/examples/Missing required values","paths/~1hubs~1{subdomain}~1maintenances/post/responses/422/content/application~1json/examples/Wrong service IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/post/responses/422/content/application~1json/examples/Missing required values","paths/~1hubs~1{subdomain}~1maintenances/post/responses/422/content/application~1json/examples/Wrong service IDs"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance/createmaintenance"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/maintenances"},{"label":"List Maintenance events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/maintenance/listmaintenances","routeSlug":"/api-v3-openapi/maintenance/listmaintenances","metadata":{"seo":{"title":"List Maintenance events","description":"Filters and returns Maintenance records for current Hub with basic info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMaintenances","name":"List Maintenance events","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1maintenances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Maintenance events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Filters and returns Maintenance records for current Hub with basic info.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_by_me","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - filter events to only those which were created by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"current user,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - filter events to only those which were "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created by current user,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - don't filter events by creator."},"children":[]}]}]}]}]},{"name":"archived","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters maintenance events by archived status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only maintenance events that were archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only maintenance events that were not archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return maintenance events without filtering by archived status."},"children":[]}]}]}]}]},{"name":"deleted","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters maintenance events by deletion status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only maintenance events that were deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only maintenance events that were not deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return maintenance events without filtering by deleted status."},"children":[]}]}]}]}]},{"name":"draft","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters events by draft status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only events that were not published yet,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only events that were published,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return events without filtering by draft status."},"children":[]}]}]}]}]},{"name":"period_name","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated period names."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters maintenance by period name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period_name=current"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"period_name=past,current"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible period name values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"past"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"future"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When not set, do not filter by period."},"children":[]}]}]}]},{"name":"service_ids","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated string of service ids."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters events by at least one affected service, specified in params."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_ids=1,2,3"},"children":[]}]}]}]},{"name":"statuses","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated string of service statuses names."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters events by at least one affected service with specified status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statuses=degraded-performance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statuses=up,down"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible incident type values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"up"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"degraded-performance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"down"},"children":[]}]}]}]}]},{"name":"start_time","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lower limit of the event start time filter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Assumed as far in the past when not provided."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter events to those which period of occurrence (from event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being far in the future for open incidents) overlaps with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" params."},"children":[]}]}]}]},{"name":"end_time","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upper limit of the event end time filter."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Assumed as far in the future when not provided."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter events to those which period of occurrence (from event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being far in the future for open incidents) overlaps with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" params."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String that filters events to those containing the search string in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"extend","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which properties should be expanded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Expanded properties contains more detailed information which is less frequently needed in typical usage."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Currently supported only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort_prop","in":"query","schemaId":"schema_17","description":"Determines which property results should be sorted by.\n"},{"name":"sort_dir","in":"query","schemaId":"schema_18","description":"Determines sorting direction."},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/maintenances","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"created_by_me","in":"query","schemaId":"schema_1"},{"name":"archived","in":"query","schemaId":"schema_2"},{"name":"deleted","in":"query","schemaId":"schema_2"},{"name":"draft","in":"query","schemaId":"schema_2"},{"name":"period_name","in":"query","schemaId":"components/schemas/components-Name"},{"name":"service_ids","in":"query","schemaId":"components/schemas/components-Name"},{"name":"statuses","in":"query","schemaId":"components/schemas/components-Name"},{"name":"start_time","in":"query","schemaId":"schema_5"},{"name":"end_time","in":"query","schemaId":"schema_6"},{"name":"q","in":"query","schemaId":"components/schemas/components-Name"},{"name":"extend","in":"query","example":"flags","schemaId":"schema_7"},{"name":"sort_prop","in":"query","schemaId":"schema_17"},{"name":"sort_dir","in":"query","schemaId":"schema_18"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/maintenances","href":"maintenance/listmaintenances","openApiOperationId":"listMaintenances","summary":"List Maintenance events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}},"schemaId":"schema_19"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1maintenances/get/responses/422/content/application~1json/examples/Invalid extend param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1maintenances/get/responses/422/content/application~1json/examples/Invalid extend param"]}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1maintenances/get/responses/422/content/application~1json/examples/Invalid extend param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1maintenances/get/responses/422/content/application~1json/examples/Invalid extend param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance/listmaintenances"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/maintenances"},{"label":"Retrieve a Maintenance event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/maintenance/getmaintenance","routeSlug":"/api-v3-openapi/maintenance/getmaintenance","metadata":{"seo":{"title":"Retrieve a Maintenance event","description":"Returns data about single maintenance event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMaintenance","name":"Retrieve a Maintenance event","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Maintenance event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about single maintenance event."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"maintenance_id","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested maintenance"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"extend","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which properties should be expanded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Expanded properties contains more detailed information which is less frequently needed in typical usage."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Currently supported only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/maintenances/{maintenance_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"maintenance_id","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"extend","in":"query","example":"flags","schemaId":"schema_7"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/maintenances/{maintenance_id}","href":"maintenance/getmaintenance","openApiOperationId":"getMaintenance","summary":"Retrieve a Maintenance event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/404/content/application~1json/examples/Invalid maintenance_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/404/content/application~1json/examples/Invalid maintenance_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/404/content/application~1json/examples/Invalid maintenance_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/404/content/application~1json/examples/Invalid maintenance_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/422/content/application~1json/examples/Invalid extend param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance/getmaintenance"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/maintenances/{maintenance_id}"},{"label":"Update a Maintenance event","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/maintenance/updatemaintenance","routeSlug":"/api-v3-openapi/maintenance/updatemaintenance","metadata":{"seo":{"title":"Update a Maintenance event","description":"Modifies an existing Maintenance. Only modified attributes may be passed in payload. All other attributes will remain unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateMaintenance","name":"Update a Maintenance event","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Maintenance event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies an existing Maintenance. Only modified attributes may be passed in payload. All other attributes will remain unchanged."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"maintenance_id","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested maintenance"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20"}},"schemaId":"schema_20","pointer":"/paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/maintenances/{maintenance_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"maintenance_id","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_20"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/maintenances/{maintenance_id}","href":"maintenance/updatemaintenance","openApiOperationId":"updateMaintenance","summary":"Update a Maintenance event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"schema_20","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/422/content/application~1json/examples/Wrong service IDs"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/422/content/application~1json/examples/Wrong service IDs"]}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/422/content/application~1json/examples/Wrong service IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/422/content/application~1json/examples/Wrong service IDs"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance/updatemaintenance"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/maintenances/{maintenance_id}"},{"label":"Delete a Maintenance event","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/maintenance/deletemaintenance","routeSlug":"/api-v3-openapi/maintenance/deletemaintenance","metadata":{"seo":{"title":"Delete a Maintenance event","description":"Deletes Maintenance record. Records are soft-deleted which means that such deleted record can still be viewed or potentially restored."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteMaintenance","name":"Delete a Maintenance event","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Maintenance event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes Maintenance record. Records are soft-deleted which means that such deleted record can still be viewed or potentially restored.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"maintenance_id","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested maintenance"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hubs/{subdomain}/maintenances/{maintenance_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"maintenance_id","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/maintenances/{maintenance_id}","href":"maintenance/deletemaintenance","openApiOperationId":"deleteMaintenance","summary":"Delete a Maintenance event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/200/content/application~1json/examples/OK"]}},"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/200/content/application~1json/examples/OK"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id"]}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/200/content/application~1json/examples/OK"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/200/content/application~1json/examples/OK"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance/deletemaintenance"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/maintenances/{maintenance_id}"}],"content":{"contentType":"group","meta":{"name":"Maintenance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Maintenance","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maintenance represents an event that:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has known start time which is typically in future - planned maintenance,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Has known end time during the moment of creation,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is a single message."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most typical use case:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub Page list various customer-facing services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One of the service will undergo a maintenance that will take it offline"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for duration of the maintenance,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ahead of time, Maintenance event is created to let customers know"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that service will not be available during the specific time frame."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/maintenances","summary":"Create a Maintenance event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/maintenance/createmaintenance","deprecated":false},{"title":"/hubs/{subdomain}/maintenances","summary":"List Maintenance events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/maintenance/listmaintenances","deprecated":false},{"title":"/hubs/{subdomain}/maintenances/{maintenance_id}","summary":"Retrieve a Maintenance event","prefix":{"name":"get","color":"get"},"badges":[],"link":"/maintenance/getmaintenance","deprecated":false},{"title":"/hubs/{subdomain}/maintenances/{maintenance_id}","summary":"Update a Maintenance event","prefix":{"name":"put","color":"put"},"badges":[],"link":"/maintenance/updatemaintenance","deprecated":false},{"title":"/hubs/{subdomain}/maintenances/{maintenance_id}","summary":"Delete a Maintenance event","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/maintenance/deletemaintenance","deprecated":false}]}]}]}]}},{"type":"group","label":"Incident Update Template","link":"/api-v3-openapi/incident-update-template","routeSlug":"/api-v3-openapi/incident-update-template","items":[{"label":"Create an Incident Update Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident-update-template/createincidentupdatetemplate","routeSlug":"/api-v3-openapi/incident-update-template/createincidentupdatetemplate","metadata":{"seo":{"title":"Create an Incident Update Template","description":"Creates a new template. Template don't have to contain values set for all possible fields. If there is no value present for one of the field, during applying the template such field will be ignored."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createIncidentUpdateTemplate","name":"Create an Incident Update Template","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Incident Update Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new template. Template don't have to contain values set for all possible fields. If there is no value present for one of the field, during applying the template such field will be ignored.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IncidentUpdateTemplatePayload"}},"schemaId":"components/schemas/IncidentUpdateTemplatePayload","pointer":"/paths/~1hubs~1{subdomain}~1incident_templates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/incident_templates","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IncidentUpdateTemplatePayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/incident_templates","href":"incident-update-template/createincidentupdatetemplate","openApiOperationId":"createIncidentUpdateTemplate","summary":"Create an Incident Update Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/IncidentUpdateTemplatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IncidentUpdateTemplatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/422/content/application~1json/examples/Missing required values"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/422/content/application~1json/examples/Missing required values"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/422/content/application~1json/examples/Missing required values"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/post/responses/422/content/application~1json/examples/Missing required values"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident-update-template/createincidentupdatetemplate"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incident_templates"},{"label":"List Incident Update Templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident-update-template/listincidentupdatetemplates","routeSlug":"/api-v3-openapi/incident-update-template/listincidentupdatetemplates","metadata":{"seo":{"title":"List Incident Update Templates","description":"Filters and returns Incident Template records for current Hub with basic info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listIncidentUpdateTemplates","name":"List Incident Update Templates","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Incident Update Templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Filters and returns Incident Template records for current Hub with basic info.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_by_me","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - filter events to only those which were created by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"current user,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - filter events to only those which were "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created by current user,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - don't filter events by creator."},"children":[]}]}]}]}]},{"name":"deleted","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters templates by deletion status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only templates that were deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only templates that were not deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return templates without filtering by deleted status."},"children":[]}]}]}]}]},{"name":"incident_types","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters Incident templates by incident type value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated incident types."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed incident types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"investigating,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identified,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"monitoring,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resolved."},"children":[]}]}]}]}]},{"name":"q","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String that filters templates to those containing the search string in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"q_label","in":"query","schemaId":"components/schemas/components-Name","description":"String that filters templates to those containing the search string in one of the labels.\n"},{"name":"sort_prop","in":"query","schemaId":"schema_22","description":"Determines which property results should be sorted by."},{"name":"sort_dir","in":"query","schemaId":"schema_4","description":"Determines sorting direction."},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/incident_templates","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"created_by_me","in":"query","schemaId":"schema_1"},{"name":"deleted","in":"query","schemaId":"schema_2"},{"name":"incident_types","in":"query","schemaId":"components/schemas/components-Name"},{"name":"q","in":"query","schemaId":"components/schemas/components-Name"},{"name":"q_label","in":"query","schemaId":"components/schemas/components-Name"},{"name":"sort_prop","in":"query","schemaId":"schema_22"},{"name":"sort_dir","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/incident_templates","href":"incident-update-template/listincidentupdatetemplates","openApiOperationId":"listIncidentUpdateTemplates","summary":"List Incident Update Templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/422/content/application~1json/examples/Invalid deleted param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/422/content/application~1json/examples/Invalid deleted param"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_23","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/422/content/application~1json/examples/Invalid deleted param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates/get/responses/422/content/application~1json/examples/Invalid deleted param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident-update-template/listincidentupdatetemplates"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incident_templates"},{"label":"Retrieve an Incident Update Template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident-update-template/getincidentupdatetemplate","routeSlug":"/api-v3-openapi/incident-update-template/getincidentupdatetemplate","metadata":{"seo":{"title":"Retrieve an Incident Update Template","description":"Returns data about single template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIncidentUpdateTemplate","name":"Retrieve an Incident Update Template","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an Incident Update Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about single template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"incident_template_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested Incident Update Template"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/incident_templates/{incident_template_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"incident_template_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/incident_templates/{incident_template_id}","href":"incident-update-template/getincidentupdatetemplate","openApiOperationId":"getIncidentUpdateTemplate","summary":"Retrieve an Incident Update Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/404/content/application~1json/examples/Invalid incident_template_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/404/content/application~1json/examples/Invalid incident_template_id"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/404/content/application~1json/examples/Invalid incident_template_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/404/content/application~1json/examples/Invalid incident_template_id"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident-update-template/getincidentupdatetemplate"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incident_templates/{incident_template_id}"},{"label":"Update an Incident Update Template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident-update-template/updateincidentupdatetemplate","routeSlug":"/api-v3-openapi/incident-update-template/updateincidentupdatetemplate","metadata":{"seo":{"title":"Update an Incident Update Template","description":"Modifies an existing template. Only modified attributes may be passed in payload. All other attributes will remain unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateIncidentUpdateTemplate","name":"Update an Incident Update Template","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an Incident Update Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies an existing template. Only modified attributes may be passed in payload. All other attributes will remain unchanged."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"incident_template_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested Incident Update Template"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IncidentUpdateTemplatePayload"}},"schemaId":"components/schemas/IncidentUpdateTemplatePayload","pointer":"/paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/incident_templates/{incident_template_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"incident_template_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IncidentUpdateTemplatePayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/incident_templates/{incident_template_id}","href":"incident-update-template/updateincidentupdatetemplate","openApiOperationId":"updateIncidentUpdateTemplate","summary":"Update an Incident Update Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/IncidentUpdateTemplatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IncidentUpdateTemplatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/404/content/application~1json/examples/Invalid incident_template_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/404/content/application~1json/examples/Invalid incident_template_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/404/content/application~1json/examples/Invalid incident_template_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/404/content/application~1json/examples/Invalid incident_template_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident-update-template/updateincidentupdatetemplate"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incident_templates/{incident_template_id}"},{"label":"Delete an Incident Update Template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/incident-update-template/deleteincidentupdatetemplate","routeSlug":"/api-v3-openapi/incident-update-template/deleteincidentupdatetemplate","metadata":{"seo":{"title":"Delete an Incident Update Template","description":"Deletes Incident Template record. Records are soft-deleted which means that such deleted record can still be viewed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteIncidentUpdateTemplate","name":"Delete an Incident Update Template","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an Incident Update Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes Incident Template record. Records are soft-deleted which means that such deleted record can still be viewed.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"incident_template_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested Incident Update Template"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hubs/{subdomain}/incident_templates/{incident_template_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"incident_template_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/incident_templates/{incident_template_id}","href":"incident-update-template/deleteincidentupdatetemplate","openApiOperationId":"deleteIncidentUpdateTemplate","summary":"Delete an Incident Update Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/200/content/application~1json/examples/OK"]}},"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/200/content/application~1json/examples/OK"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/404/content/application~1json/examples/Invalid incident_template_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/404/content/application~1json/examples/Invalid incident_template_id"]}],"pointer":"/paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/200/content/application~1json/examples/OK"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/200/content/application~1json/examples/OK"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/404/content/application~1json/examples/Invalid incident_template_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/404/content/application~1json/examples/Invalid incident_template_id"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/incident-update-template/deleteincidentupdatetemplate"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/incident_templates/{incident_template_id}"}],"content":{"contentType":"group","meta":{"name":"Incident Update Template"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Incident Update Template","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incident Update Template is used to create Incident Updates in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"StatusHub Control Panel quicker."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It can contain predefined:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"body,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"incident type,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"service statuses."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/incident_templates","summary":"Create an Incident Update Template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/incident-update-template/createincidentupdatetemplate","deprecated":false},{"title":"/hubs/{subdomain}/incident_templates","summary":"List Incident Update Templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/incident-update-template/listincidentupdatetemplates","deprecated":false},{"title":"/hubs/{subdomain}/incident_templates/{incident_template_id}","summary":"Retrieve an Incident Update Template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/incident-update-template/getincidentupdatetemplate","deprecated":false},{"title":"/hubs/{subdomain}/incident_templates/{incident_template_id}","summary":"Update an Incident Update Template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/incident-update-template/updateincidentupdatetemplate","deprecated":false},{"title":"/hubs/{subdomain}/incident_templates/{incident_template_id}","summary":"Delete an Incident Update Template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/incident-update-template/deleteincidentupdatetemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Maintenance Template","link":"/api-v3-openapi/maintenance-template","routeSlug":"/api-v3-openapi/maintenance-template","items":[{"label":"Create a Maintenance Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/maintenance-template/createmaintenancetemplate","routeSlug":"/api-v3-openapi/maintenance-template/createmaintenancetemplate","metadata":{"seo":{"title":"Create a Maintenance Template","description":"Creates a new template. Template don't have to contain values set for all possible fields. If there is no value present for one of the field, during applying the template such field will be ignored."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMaintenanceTemplate","name":"Create a Maintenance Template","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Maintenance Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new template. Template don't have to contain values set for all possible fields. If there is no value present for one of the field, during applying the template such field will be ignored.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MaintenanceTemplatePayload"}},"schemaId":"components/schemas/MaintenanceTemplatePayload","pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/maintenance_templates","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MaintenanceTemplatePayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/maintenance_templates","href":"maintenance-template/createmaintenancetemplate","openApiOperationId":"createMaintenanceTemplate","summary":"Create a Maintenance Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/MaintenanceTemplatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MaintenanceTemplatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/422/content/application~1json/examples/Missing required values"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/422/content/application~1json/examples/Missing required values"]}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/422/content/application~1json/examples/Missing required values"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/422/content/application~1json/examples/Missing required values"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance-template/createmaintenancetemplate"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/maintenance_templates"},{"label":"List Maintenance Templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/maintenance-template/listmaintenancetemplates","routeSlug":"/api-v3-openapi/maintenance-template/listmaintenancetemplates","metadata":{"seo":{"title":"List Maintenance Templates","description":"Filters and returns Maintenance Template records for current Hub with basic info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMaintenanceTemplates","name":"List Maintenance Templates","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Maintenance Templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Filters and returns Maintenance Template records for current Hub with basic info.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_by_me","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - filter events to only those which were created by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"current user,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - filter events to only those which were "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created by current user,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - don't filter events by creator."},"children":[]}]}]}]}]},{"name":"deleted","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters templates by deletion status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only templates that were deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only templates that were not deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return templates without filtering by deleted status."},"children":[]}]}]}]}]},{"name":"q","in":"query","schemaId":"components/schemas/components-Name","description":"Query string"},{"name":"q_label","in":"query","schemaId":"components/schemas/components-Name","description":"Query label"},{"name":"sort_prop","in":"query","schemaId":"schema_22","description":"Determines which property results should be sorted by."},{"name":"sort_dir","in":"query","schemaId":"schema_4","description":"Determines sorting direction."},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/maintenance_templates","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"created_by_me","in":"query","schemaId":"schema_1"},{"name":"deleted","in":"query","schemaId":"schema_2"},{"name":"q","in":"query","schemaId":"components/schemas/components-Name"},{"name":"q_label","in":"query","schemaId":"components/schemas/components-Name"},{"name":"sort_prop","in":"query","schemaId":"schema_22"},{"name":"sort_dir","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/maintenance_templates","href":"maintenance-template/listmaintenancetemplates","openApiOperationId":"listMaintenanceTemplates","summary":"List Maintenance Templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/422/content/application~1json/examples/Invalid deleted param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/422/content/application~1json/examples/Invalid deleted param"]}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/422/content/application~1json/examples/Invalid deleted param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/422/content/application~1json/examples/Invalid deleted param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance-template/listmaintenancetemplates"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/maintenance_templates"},{"label":"Retrieve a Maintenance Template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/maintenance-template/getmaintenancetemplate","routeSlug":"/api-v3-openapi/maintenance-template/getmaintenancetemplate","metadata":{"seo":{"title":"Retrieve a Maintenance Template","description":"Returns data about single template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMaintenanceTemplate","name":"Retrieve a Maintenance Template","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Maintenance Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about single template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"maintenance_template_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested Maintenance Template"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/maintenance_templates/{maintenance_template_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"maintenance_template_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/maintenance_templates/{maintenance_template_id}","href":"maintenance-template/getmaintenancetemplate","openApiOperationId":"getMaintenanceTemplate","summary":"Retrieve a Maintenance Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/404/content/application~1json/examples/Invalid maintenance_template_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/404/content/application~1json/examples/Invalid maintenance_template_id"]}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/404/content/application~1json/examples/Invalid maintenance_template_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/404/content/application~1json/examples/Invalid maintenance_template_id"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance-template/getmaintenancetemplate"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/maintenance_templates/{maintenance_template_id}"},{"label":"Update a Maintenance Template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/maintenance-template/updatemaintenancetemplate","routeSlug":"/api-v3-openapi/maintenance-template/updatemaintenancetemplate","metadata":{"seo":{"title":"Update a Maintenance Template","description":"Modifies an existing template. Only modified attributes may be passed in payload. All other attributes will remain unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateMaintenanceTemplate","name":"Update a Maintenance Template","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Maintenance Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies an existing template. Only modified attributes may be passed in payload. All other attributes will remain unchanged."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"maintenance_template_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested Maintenance Template"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MaintenanceTemplatePayload"}},"schemaId":"components/schemas/MaintenanceTemplatePayload","pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/maintenance_templates/{maintenance_template_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"maintenance_template_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MaintenanceTemplatePayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/maintenance_templates/{maintenance_template_id}","href":"maintenance-template/updatemaintenancetemplate","openApiOperationId":"updateMaintenanceTemplate","summary":"Update a Maintenance Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/MaintenanceTemplatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MaintenanceTemplatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/404/content/application~1json/examples/Invalid maintenance_template_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/404/content/application~1json/examples/Invalid maintenance_template_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/404/content/application~1json/examples/Invalid maintenance_template_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/404/content/application~1json/examples/Invalid maintenance_template_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance-template/updatemaintenancetemplate"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/maintenance_templates/{maintenance_template_id}"},{"label":"Delete a Maintenance Template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/maintenance-template/deletemaintenancetemplate","routeSlug":"/api-v3-openapi/maintenance-template/deletemaintenancetemplate","metadata":{"seo":{"title":"Delete a Maintenance Template","description":"Deletes Maintenance Template record. Records are soft-deleted which means that such deleted record can still be viewed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteMaintenanceTemplate","name":"Delete a Maintenance Template","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Maintenance Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes Maintenance Template record. Records are soft-deleted which means that such deleted record can still be viewed.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"maintenance_template_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the requested Maintenance Template"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hubs/{subdomain}/maintenance_templates/{maintenance_template_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"maintenance_template_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/maintenance_templates/{maintenance_template_id}","href":"maintenance-template/deletemaintenancetemplate","openApiOperationId":"deleteMaintenanceTemplate","summary":"Delete a Maintenance Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/200/content/application~1json/examples/OK"]}},"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/200/content/application~1json/examples/OK"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/404/content/application~1json/examples/Invalid maintenance_template_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/404/content/application~1json/examples/Invalid maintenance_template_id"]}],"pointer":"/paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/200/content/application~1json/examples/OK"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/200/content/application~1json/examples/OK"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/404/content/application~1json/examples/Invalid maintenance_template_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/404/content/application~1json/examples/Invalid maintenance_template_id"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/maintenance-template/deletemaintenancetemplate"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/maintenance_templates/{maintenance_template_id}"}],"content":{"contentType":"group","meta":{"name":"Maintenance Template"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Maintenance Template","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maintenance Template is used to create Maintenance event in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"StatusHub Control Panel quicker."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It can contain predefined:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"body,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"duration,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"service statuses."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/maintenance_templates","summary":"Create a Maintenance Template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/maintenance-template/createmaintenancetemplate","deprecated":false},{"title":"/hubs/{subdomain}/maintenance_templates","summary":"List Maintenance Templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/maintenance-template/listmaintenancetemplates","deprecated":false},{"title":"/hubs/{subdomain}/maintenance_templates/{maintenance_template_id}","summary":"Retrieve a Maintenance Template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/maintenance-template/getmaintenancetemplate","deprecated":false},{"title":"/hubs/{subdomain}/maintenance_templates/{maintenance_template_id}","summary":"Update a Maintenance Template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/maintenance-template/updatemaintenancetemplate","deprecated":false},{"title":"/hubs/{subdomain}/maintenance_templates/{maintenance_template_id}","summary":"Delete a Maintenance Template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/maintenance-template/deletemaintenancetemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Platform Alert","link":"/api-v3-openapi/platform-alert","routeSlug":"/api-v3-openapi/platform-alert","items":[{"label":"Show Platform Alert data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/platform-alert/paths/~1hubs~1{subdomain}~1platform_alert/get","routeSlug":"/api-v3-openapi/platform-alert/paths/~1hubs~1{subdomain}~1platform_alert/get","metadata":{"seo":{"title":"Show Platform Alert data","description":"Returns data about Platform Alert state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Show Platform Alert data","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1platform_alert/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Show Platform Alert data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about Platform Alert state.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1platform_alert/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1platform_alert/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/platform_alert","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/platform_alert","href":"platform-alert/paths/~1hubs~1{subdomain}~1platform_alert/get","summary":"Show Platform Alert data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/get/responses/404/content/application~1json/examples/Invalid subdomain"]}],"pointer":"/paths/~1hubs~1{subdomain}~1platform_alert/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-alert/paths/~1hubs~1{subdomain}~1platform_alert/get"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/platform_alert"},{"label":"Set/Unset Platform Alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/platform-alert/paths/~1hubs~1{subdomain}~1platform_alert/post","routeSlug":"/api-v3-openapi/platform-alert/paths/~1hubs~1{subdomain}~1platform_alert/post","metadata":{"seo":{"title":"Set/Unset Platform Alert","description":"Sets Platform Alert state. Can be used to both set/enable the Platform Alert as well as to unset/disable it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Set/Unset Platform Alert","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1platform_alert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set/Unset Platform Alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets Platform Alert state."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can be used to both set/enable the Platform Alert as well as to unset/disable it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1platform_alert/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1platform_alert/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformAlert"}},"schemaId":"components/schemas/PlatformAlert","pointer":"/paths/~1hubs~1{subdomain}~1platform_alert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/platform_alert","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PlatformAlert"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/platform_alert","href":"platform-alert/paths/~1hubs~1{subdomain}~1platform_alert/post","summary":"Set/Unset Platform Alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/PlatformAlert","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PlatformAlert"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/422/content/application~1json/examples/Empty body"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/422/content/application~1json/examples/Empty body"]}],"pointer":"/paths/~1hubs~1{subdomain}~1platform_alert/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/422/content/application~1json/examples/Empty body"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1platform_alert/post/responses/422/content/application~1json/examples/Empty body"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-alert/paths/~1hubs~1{subdomain}~1platform_alert/post"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/platform_alert"}],"content":{"contentType":"group","meta":{"name":"Platform Alert"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Platform Alert","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform Alert is a state of Hub which typically represent major event"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"affecting whole product as opposed to Incident or Maintenance which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"affects specific services."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Platform Alert is not connected with any service and therefore"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notifications about Platform Alert are sent to all subscriptions"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"regardless of their service selection."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/platform_alert","summary":"Show Platform Alert data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/platform-alert/paths/~1hubs~1{subdomain}~1platform_alert/get","deprecated":false},{"title":"/hubs/{subdomain}/platform_alert","summary":"Set/Unset Platform Alert","prefix":{"name":"post","color":"post"},"badges":[],"link":"/platform-alert/paths/~1hubs~1{subdomain}~1platform_alert/post","deprecated":false}]}]}]}]}},{"type":"separator","label":"Hub","content":null},{"type":"group","label":"Hub","link":"/api-v3-openapi/hub","routeSlug":"/api-v3-openapi/hub","items":[{"label":"List of Hubs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub/paths/~1hubs/get","routeSlug":"/api-v3-openapi/hub/paths/~1hubs/get","metadata":{"seo":{"title":"List of Hubs","description":"Filters and returns Hub records with basic info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List of Hubs","isWebhook":false,"pointer":"/paths/~1hubs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of Hubs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Filters and returns Hub records with basic info.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_27","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters Hubs by their type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only Primary Hubs,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=connected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only Connected Hubs."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary Hub - Independent Hub without any overlap with other"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hubs data."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated with billing subscription."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can have Connected Hubs if its subscription allows it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connected Hub - Hub that shares following aspects with its Primary Hub"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Groups,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events affecting the shared Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other data like Subscriptions and settings is independent."},"children":[]}]}]}]}]}]},{"name":"parent_id","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for Connected Hubs."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters Hubs by their Primary Hub ID."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String that filters Hubs to those containing the search string in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"sort_prop","in":"query","schemaId":"schema_28","description":"Determines which property results should be sorted by.\n"},{"name":"sort_dir","in":"query","schemaId":"schema_29","description":"Determines sorting direction.\n"},{"name":"per_parent_sort","in":"query","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for Connected Hubs."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - sorts Connected Hubs by their parent Primary Hub position,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - omits sorting Connected Hubs by their parent Primary Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"position."},"children":[]}]}]}]}]},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[],"query":[{"name":"type","in":"query","schemaId":"schema_27"},{"name":"parent_id","in":"query","schemaId":"components/schemas/components-Name"},{"name":"q","in":"query","schemaId":"components/schemas/components-Name"},{"name":"sort_prop","in":"query","schemaId":"schema_28"},{"name":"sort_dir","in":"query","schemaId":"schema_29"},{"name":"per_parent_sort","in":"query","schemaId":"schema_30"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422"],"pointer":"/hubs","href":"hub/paths/~1hubs/get","summary":"List of Hubs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}},"schemaId":"schema_31"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs/get/responses/403/content/application~1json/examples/No access to any of Hubs"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs/get/responses/403/content/application~1json/examples/No access to any of Hubs"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs/get/responses/422/content/application~1json/examples/Invalid type param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs/get/responses/422/content/application~1json/examples/Invalid type param"]}],"pointer":"/paths/~1hubs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs/get/responses/403/content/application~1json/examples/No access to any of Hubs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs/get/responses/403/content/application~1json/examples/No access to any of Hubs"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs/get/responses/422/content/application~1json/examples/Invalid type param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs/get/responses/422/content/application~1json/examples/Invalid type param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub/paths/~1hubs/get"}],"panels":[]}]},"httpPath":"/hubs"},{"label":"Show Hub","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}/get","routeSlug":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}/get","metadata":{"seo":{"title":"Show Hub","description":"Returns data about single Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Show Hub","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Show Hub","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about single Hub."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}","href":"hub/paths/~1hubs~1{subdomain}/get","summary":"Show Hub"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}},"schemaId":"schema_32"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}],"pointer":"/paths/~1hubs~1{subdomain}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_32","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub/paths/~1hubs~1{subdomain}/get"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}"},{"label":"Update hub","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}/put","routeSlug":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}/put","metadata":{"seo":{"title":"Update hub","description":"Modifies basic settings of an existing Hub. Only modified attributes may be passed in payload. All other attributes will remain unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update hub","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update hub","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies basic settings of an existing Hub. Only modified attributes may be passed in payload. All other attributes will remain unchanged.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HubDetailsPayload"}},"schemaId":"components/schemas/HubDetailsPayload","pointer":"/paths/~1hubs~1{subdomain}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/HubDetailsPayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}","href":"hub/paths/~1hubs~1{subdomain}/put","summary":"Update hub"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/HubDetailsPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HubDetailsPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}},"schemaId":"schema_32"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/422/content/application~1json/examples/Wrong product_url format"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/422/content/application~1json/examples/Wrong product_url format"]}],"pointer":"/paths/~1hubs~1{subdomain}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_32","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/422/content/application~1json/examples/Wrong product_url format"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}/put/responses/422/content/application~1json/examples/Wrong product_url format"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub/paths/~1hubs~1{subdomain}/put"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}"},{"label":"Hub services conditions overview","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1status~1counters/get","routeSlug":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1status~1counters/get","metadata":{"seo":{"title":"Hub services conditions overview","description":"Returns Hub services conditions overview"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Hub services conditions overview","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1status~1counters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Hub services conditions overview","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns Hub services conditions overview"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1status~1counters/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1status~1counters/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/status/counters","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/status/counters","href":"hub/paths/~1hubs~1{subdomain}~1status~1counters/get","summary":"Hub services conditions overview"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusCounters"}},"schemaId":"components/schemas/StatusCounters"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1status~1counters/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1status~1counters/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1status~1counters/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1status~1counters/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1status~1counters/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1status~1counters/get/responses/404/content/application~1json/examples/Invalid subdomain"]}],"pointer":"/paths/~1hubs~1{subdomain}~1status~1counters/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatusCounters","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusCounters"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1status~1counters/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1status~1counters/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1status~1counters/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1status~1counters/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1status~1counters/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1status~1counters/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub/paths/~1hubs~1{subdomain}~1status~1counters/get"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/status/counters"},{"label":"List of Connected Hubs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1connected_hubs/get","routeSlug":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1connected_hubs/get","metadata":{"seo":{"title":"List of Connected Hubs","description":"Filters and returns Connected Hub records for current Primary Hub with basic info. Request valid only in scope of Primary Hub and can't be used in scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List of Connected Hubs","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of Connected Hubs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters and returns Connected Hub records for current Primary Hub with basic info."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary Hub and can't be used in scope of a Connected Hub."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of Primary Hub for requested Connected Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"q","in":"query","schemaId":"components/schemas/components-Name","description":"Query string"},{"name":"sort_prop","in":"query","schemaId":"schema_28","description":"Determines which property results should be sorted by.\n"},{"name":"sort_dir","in":"query","schemaId":"schema_29","description":"Determines sorting direction.\n"},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/connected_hubs","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"q","in":"query","schemaId":"components/schemas/components-Name"},{"name":"sort_prop","in":"query","schemaId":"schema_28"},{"name":"sort_dir","in":"query","schemaId":"schema_29"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/connected_hubs","href":"hub/paths/~1hubs~1{subdomain}~1connected_hubs/get","summary":"List of Connected Hubs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/422/content/application~1json/examples/Invalid Hub Type","paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/422/content/application~1json/examples/Invalid sort_prop param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/422/content/application~1json/examples/Invalid Hub Type","paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/422/content/application~1json/examples/Invalid sort_prop param"]}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/422/content/application~1json/examples/Invalid Hub Type","paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/422/content/application~1json/examples/Invalid sort_prop param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/422/content/application~1json/examples/Invalid Hub Type","paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/422/content/application~1json/examples/Invalid sort_prop param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub/paths/~1hubs~1{subdomain}~1connected_hubs/get"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/connected_hubs"},{"label":"Create a new Connected Hub","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1connected_hubs/post","routeSlug":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1connected_hubs/post","metadata":{"seo":{"title":"Create a new Connected Hub","description":"Creates a new Connected Hub for current Primary Hub. Request valid only in scope of Primary Hub and can't be used in scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a new Connected Hub","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Connected Hub","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Connected Hub for current Primary Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary Hub and can't be used in scope of a Connected Hub."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of Primary Hub for requested Connected Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HubDetailsPayload"}},"schemaId":"components/schemas/HubDetailsPayload","pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/connected_hubs","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/HubDetailsPayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/connected_hubs","href":"hub/paths/~1hubs~1{subdomain}~1connected_hubs/post","summary":"Create a new Connected Hub"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/HubDetailsPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HubDetailsPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Invalid or not available subdomain","paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Invalid Hub Type","paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Quota has been reached","paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Wrong product_url format"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Invalid or not available subdomain","paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Invalid Hub Type","paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Quota has been reached","paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Wrong product_url format"]}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Invalid or not available subdomain","paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Invalid Hub Type","paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Quota has been reached","paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Wrong product_url format"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Invalid or not available subdomain","paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Invalid Hub Type","paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Quota has been reached","paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Wrong product_url format"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub/paths/~1hubs~1{subdomain}~1connected_hubs/post"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/connected_hubs"},{"label":"Show Connected Hub","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get","routeSlug":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get","metadata":{"seo":{"title":"Show Connected Hub","description":"Returns data about single Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Show Connected Hub","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Show Connected Hub","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about single Connected Hub."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of Primary Hub for requested Connected Hub."},"children":[]}]}]}],"required":true},{"name":"connected_subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of Connected Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"connected_subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}","href":"hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get","summary":"Show Connected Hub"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}"},{"label":"Update Connected Hub","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put","routeSlug":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put","metadata":{"seo":{"title":"Update Connected Hub","description":"Modifies basic settings of an existing Connected Hub. Only modified attributes may be passed in payload. All other attributes will remain unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Connected Hub","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Connected Hub","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies basic settings of an existing Connected Hub. Only modified attributes may be passed in payload. All other attributes will remain unchanged.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of Primary Hub for requested Connected Hub."},"children":[]}]}]}],"required":true},{"name":"connected_subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of Connected Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HubDetailsPayload"}},"schemaId":"components/schemas/HubDetailsPayload","pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"connected_subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/HubDetailsPayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}","href":"hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put","summary":"Update Connected Hub"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/HubDetailsPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HubDetailsPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/422/content/application~1json/examples/Wrong product_url format"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/422/content/application~1json/examples/Wrong product_url format"]}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/422/content/application~1json/examples/Wrong product_url format"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/422/content/application~1json/examples/Wrong product_url format"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}"},{"label":"Delete a Connected Hub","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete","routeSlug":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete","metadata":{"seo":{"title":"Delete a Connected Hub","description":"Deletes Connected Hub record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a Connected Hub","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Connected Hub","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes Connected Hub record.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of Primary Hub for requested Connected Hub."},"children":[]}]}]}],"required":true},{"name":"connected_subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of Connected Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"connected_subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}","href":"hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete","summary":"Delete a Connected Hub"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/200/content/application~1json/examples/OK"]}},"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/200/content/application~1json/examples/OK"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/404/content/application~1json/examples/Invalid incident_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/404/content/application~1json/examples/Invalid incident_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/200/content/application~1json/examples/OK"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/200/content/application~1json/examples/OK"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/404/content/application~1json/examples/Invalid incident_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/404/content/application~1json/examples/Invalid incident_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}"},{"label":"Copy Connected Hub","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post","routeSlug":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post","metadata":{"seo":{"title":"Copy Connected Hub","description":"Creates a new Connected Hub with same settings as existing Connected Hub.Copying will preserve all configuration options which includes:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Copy Connected Hub","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy Connected Hub","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Connected Hub with same settings as existing Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copying will preserve all configuration options which includes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub properties (excluding custom domain)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Privacy settings"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of associated services and groups"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appearance settings"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notification settings"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Features enabled by StatusHub support"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copy will "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" copy events nor subscribers data."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of Primary Hub for requested Connected Hub."},"children":[]}]}]}],"required":true},{"name":"connected_subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of Connected Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HubDetailsPayload"}},"schemaId":"components/schemas/HubDetailsPayload","pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}/copy","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"connected_subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/HubDetailsPayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}/copy","href":"hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post","summary":"Copy Connected Hub"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/HubDetailsPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HubDetailsPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Invalid or not available subdomain","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Quota has been reached","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Wrong product_url format"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Invalid or not available subdomain","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Quota has been reached","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Wrong product_url format"]}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Invalid or not available subdomain","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Quota has been reached","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Wrong product_url format"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Invalid or not available subdomain","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Quota has been reached","paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Wrong product_url format"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}/copy"},{"label":"Show Hub appearance settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1appearance/get","routeSlug":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1appearance/get","metadata":{"seo":{"title":"Show Hub appearance settings","description":"Returns data about Hub appearance settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Show Hub appearance settings","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1appearance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Show Hub appearance settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about Hub appearance settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1appearance/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1appearance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/appearance","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/appearance","href":"hub/paths/~1hubs~1{subdomain}~1appearance/get","summary":"Show Hub appearance settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/get/responses/404/content/application~1json/examples/Invalid subdomain"]}],"pointer":"/paths/~1hubs~1{subdomain}~1appearance/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub/paths/~1hubs~1{subdomain}~1appearance/get"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/appearance"},{"label":"Update Hub appearance settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1appearance/put","routeSlug":"/api-v3-openapi/hub/paths/~1hubs~1{subdomain}~1appearance/put","metadata":{"seo":{"title":"Update Hub appearance settings","description":"Modifies an existing Hub appearance settings. Only modified attributes may be passed in payload. All other attributes will remain unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Hub appearance settings","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1appearance/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Hub appearance settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies an existing Hub appearance settings. Only modified attributes may be passed in payload. All other attributes will remain unchanged.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1appearance/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1appearance/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppearancePayload"}},"schemaId":"components/schemas/AppearancePayload","pointer":"/paths/~1hubs~1{subdomain}~1appearance/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/appearance","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppearancePayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/appearance","href":"hub/paths/~1hubs~1{subdomain}~1appearance/put","summary":"Update Hub appearance settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/AppearancePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppearancePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/422/content/application~1json/examples/Missing navbar item url"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/422/content/application~1json/examples/Missing navbar item url"]}],"pointer":"/paths/~1hubs~1{subdomain}~1appearance/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/422/content/application~1json/examples/Missing navbar item url"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1appearance/put/responses/422/content/application~1json/examples/Missing navbar item url"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub/paths/~1hubs~1{subdomain}~1appearance/put"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/appearance"}],"content":{"contentType":"group","meta":{"name":"Hub"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Hub","showPageActions":true},{"nodeType":"markdoc","content":"Hub is a central record that represents the status page and holds\nall related records."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs","summary":"List of Hubs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hub/paths/~1hubs/get","deprecated":false},{"title":"/hubs/{subdomain}","summary":"Show Hub","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hub/paths/~1hubs~1{subdomain}/get","deprecated":false},{"title":"/hubs/{subdomain}","summary":"Update hub","prefix":{"name":"put","color":"put"},"badges":[],"link":"/hub/paths/~1hubs~1{subdomain}/put","deprecated":false},{"title":"/hubs/{subdomain}/status/counters","summary":"Hub services conditions overview","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hub/paths/~1hubs~1{subdomain}~1status~1counters/get","deprecated":false},{"title":"/hubs/{subdomain}/connected_hubs","summary":"List of Connected Hubs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hub/paths/~1hubs~1{subdomain}~1connected_hubs/get","deprecated":false},{"title":"/hubs/{subdomain}/connected_hubs","summary":"Create a new Connected Hub","prefix":{"name":"post","color":"post"},"badges":[],"link":"/hub/paths/~1hubs~1{subdomain}~1connected_hubs/post","deprecated":false},{"title":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}","summary":"Show Connected Hub","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get","deprecated":false},{"title":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}","summary":"Update Connected Hub","prefix":{"name":"put","color":"put"},"badges":[],"link":"/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put","deprecated":false},{"title":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}","summary":"Delete a Connected Hub","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete","deprecated":false},{"title":"/hubs/{subdomain}/connected_hubs/{connected_subdomain}/copy","summary":"Copy Connected Hub","prefix":{"name":"post","color":"post"},"badges":[],"link":"/hub/paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post","deprecated":false},{"title":"/hubs/{subdomain}/appearance","summary":"Show Hub appearance settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hub/paths/~1hubs~1{subdomain}~1appearance/get","deprecated":false},{"title":"/hubs/{subdomain}/appearance","summary":"Update Hub appearance settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/hub/paths/~1hubs~1{subdomain}~1appearance/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Hub Privacy","link":"/api-v3-openapi/hub-privacy","routeSlug":"/api-v3-openapi/hub-privacy","items":[{"label":"Retrieve Hub privacy state","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction/get","routeSlug":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction/get","metadata":{"seo":{"title":"Retrieve Hub privacy state","description":"Lists all available methods for restricting access to the Hub as well asthe currently enabled access restriction method or publicif Hub is public."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Retrieve Hub privacy state","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Hub privacy state","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all available methods for restricting access to the Hub as well as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the currently enabled access restriction method or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if Hub is public."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/access_restriction","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/access_restriction","href":"hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction/get","summary":"Retrieve Hub privacy state"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction/get/responses/404/content/application~1json/examples/Invalid subdomain"]}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction/get"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/access_restriction"},{"label":"Retrieve SAML settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1saml/get","routeSlug":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1saml/get","metadata":{"seo":{"title":"Retrieve SAML settings","description":"Returns data about SAML authentication."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Retrieve SAML settings","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1saml/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve SAML settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about SAML authentication."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/access_restriction/saml","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/access_restriction/saml","href":"hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1saml/get","summary":"Retrieve SAML settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}},"schemaId":"schema_37"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/404/content/application~1json/examples/Invalid subdomain"]}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_37","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1saml/get"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/access_restriction/saml"},{"label":"Update SAML authentication settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1saml/put","routeSlug":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1saml/put","metadata":{"seo":{"title":"Update SAML authentication settings","description":"Modifies SAML authentication settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update SAML authentication settings","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1saml/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update SAML authentication settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies SAML authentication settings.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SAMLPayload"}},"schemaId":"components/schemas/SAMLPayload","pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/access_restriction/saml","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SAMLPayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/access_restriction/saml","href":"hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1saml/put","summary":"Update SAML authentication settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/SAMLPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SAMLPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}},"schemaId":"schema_37"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/422/content/application~1json/examples/IdP metadata not compatible with SLO"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/422/content/application~1json/examples/IdP metadata not compatible with SLO"]}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_37","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/422/content/application~1json/examples/IdP metadata not compatible with SLO"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/422/content/application~1json/examples/IdP metadata not compatible with SLO"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1saml/put"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/access_restriction/saml"},{"label":"Retrieve Google OAuth settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get","routeSlug":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get","metadata":{"seo":{"title":"Retrieve Google OAuth settings","description":"Returns data about Google OAuth authorization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Retrieve Google OAuth settings","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Google OAuth settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about Google OAuth authorization.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/access_restriction/google_oauth","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/access_restriction/google_oauth","href":"hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get","summary":"Retrieve Google OAuth settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/404/content/application~1json/examples/Invalid subdomain"]}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/access_restriction/google_oauth"},{"label":"Update Google OAuth authorization settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put","routeSlug":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put","metadata":{"seo":{"title":"Update Google OAuth authorization settings","description":"Modifies Google OAuth authorization settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Google OAuth authorization settings","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Google OAuth authorization settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies Google OAuth authorization settings.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleOAuthPayload"}},"schemaId":"components/schemas/GoogleOAuthPayload","pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/access_restriction/google_oauth","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GoogleOAuthPayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/access_restriction/google_oauth","href":"hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put","summary":"Update Google OAuth authorization settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/GoogleOAuthPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleOAuthPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/422/content/application~1json/examples/Domains whitelist not set"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/422/content/application~1json/examples/Domains whitelist not set"]}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/422/content/application~1json/examples/Domains whitelist not set"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/422/content/application~1json/examples/Domains whitelist not set"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/access_restriction/google_oauth"},{"label":"Retrieve Hub password settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get","routeSlug":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get","metadata":{"seo":{"title":"Retrieve Hub password settings","description":"Returns data about Hub password."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Retrieve Hub password settings","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Hub password settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about Hub password."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/access_restriction/global_password","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/access_restriction/global_password","href":"hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get","summary":"Retrieve Hub password settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/404/content/application~1json/examples/Invalid subdomain"]}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/access_restriction/global_password"},{"label":"Update Hub password settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put","routeSlug":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put","metadata":{"seo":{"title":"Update Hub password settings","description":"Modifies Hub password settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Hub password settings","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Hub password settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modifies Hub password settings."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GlobalPasswordPayload"}},"schemaId":"components/schemas/GlobalPasswordPayload","pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/access_restriction/global_password","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GlobalPasswordPayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/access_restriction/global_password","href":"hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put","summary":"Update Hub password settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/GlobalPasswordPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GlobalPasswordPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/422/content/application~1json/examples/Too short password"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/422/content/application~1json/examples/Too short password"]}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/422/content/application~1json/examples/Too short password"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/422/content/application~1json/examples/Too short password"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/access_restriction/global_password"},{"label":"Retrieve domain-based restriction details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get","routeSlug":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get","metadata":{"seo":{"title":"Retrieve domain-based restriction details","description":"Returns data about domain-based restriction for Hub access restrictionmethods providing authentication of user with user email.Applies to:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Retrieve domain-based restriction details","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve domain-based restriction details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns data about domain-based restriction for Hub access restriction"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"methods providing authentication of user with user email."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAML - optional,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google OAuth - required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once set if visitor trying to sign-in has a domain reported by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication method not matching any of the domains in domains whitelist,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the access to Hub is not granted even if authentication method normally"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"would grant access to this visitor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required to be enabled when using Google OAuth restriction method."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/access_restriction/domains_whitelist","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/access_restriction/domains_whitelist","href":"hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get","summary":"Retrieve domain-based restriction details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/404/content/application~1json/examples/Invalid subdomain"]}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/access_restriction/domains_whitelist"},{"label":"Update Hub domain-based restrictions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put","routeSlug":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put","metadata":{"seo":{"title":"Update Hub domain-based restrictions","description":"Modified the domain-based restrictions settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Hub domain-based restrictions","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Hub domain-based restrictions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modified the domain-based restrictions settings.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DomainsWhitelistPayload"}},"schemaId":"components/schemas/DomainsWhitelistPayload","pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/access_restriction/domains_whitelist","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DomainsWhitelistPayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/access_restriction/domains_whitelist","href":"hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put","summary":"Update Hub domain-based restrictions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/DomainsWhitelistPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DomainsWhitelistPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/422/content/application~1json/examples/Google OAuth is enabled"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/422/content/application~1json/examples/Google OAuth is enabled"]}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/422/content/application~1json/examples/Google OAuth is enabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/422/content/application~1json/examples/Google OAuth is enabled"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/access_restriction/domains_whitelist"},{"label":"Retrieve ip-based restriction details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get","routeSlug":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get","metadata":{"seo":{"title":"Retrieve ip-based restriction details","description":"Returns data about ip-based restriction for Hub.If enabled only visitors from whitelisted IP addresser or IP rangesare allowed to access the Hub. All other visitors will see 404 error.Supported address formats:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Retrieve ip-based restriction details","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve ip-based restriction details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns data about ip-based restriction for Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If enabled only visitors from whitelisted IP addresser or IP ranges"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are allowed to access the Hub. All other visitors will see 404 error."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported address formats:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP V4 address,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP V4 range in CIDR notation."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/access_restriction/ip_whitelist","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/access_restriction/ip_whitelist","href":"hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get","summary":"Retrieve ip-based restriction details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/404/content/application~1json/examples/Invalid subdomain"]}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/access_restriction/ip_whitelist"},{"label":"Update Hub ip-based restrictions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put","routeSlug":"/api-v3-openapi/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put","metadata":{"seo":{"title":"Update Hub ip-based restrictions","description":"Modified the ip-based restrictions settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Hub ip-based restrictions","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Hub ip-based restrictions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Modified the ip-based restrictions settings.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NetworkPayload"}},"schemaId":"components/schemas/NetworkPayload","pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/access_restriction/ip_whitelist","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NetworkPayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/access_restriction/ip_whitelist","href":"hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put","summary":"Update Hub ip-based restrictions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/NetworkPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NetworkPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/422/content/application~1json/examples/Invalid address format"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/422/content/application~1json/examples/Invalid address format"]}],"pointer":"/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/422/content/application~1json/examples/Invalid address format"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/422/content/application~1json/examples/Invalid address format"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/access_restriction/ip_whitelist"}],"content":{"contentType":"group","meta":{"name":"Hub Privacy"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Hub Privacy","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows managing various methods limiting access to a Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User-based methods - only one can be active in the same time:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAML 2.0 - Recommended method offering the most flexibility"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and security,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Google OAuth - Use email address domain of user Google Account to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"limit the access to only those domains which are whitelisted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Very easy to setup for companies using Google services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub Password - Most basic method which use a single password"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that can be used by anyone in order to see the Hub Page."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Network-based methods:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP whitelist - Allow to specify a whitelist of IP V4 addresses and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP V4 ranges from which users are allowed to access the Hub Page."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/access_restriction","summary":"Retrieve Hub privacy state","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction/get","deprecated":false},{"title":"/hubs/{subdomain}/access_restriction/saml","summary":"Retrieve SAML settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1saml/get","deprecated":false},{"title":"/hubs/{subdomain}/access_restriction/saml","summary":"Update SAML authentication settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1saml/put","deprecated":false},{"title":"/hubs/{subdomain}/access_restriction/google_oauth","summary":"Retrieve Google OAuth settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get","deprecated":false},{"title":"/hubs/{subdomain}/access_restriction/google_oauth","summary":"Update Google OAuth authorization settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put","deprecated":false},{"title":"/hubs/{subdomain}/access_restriction/global_password","summary":"Retrieve Hub password settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get","deprecated":false},{"title":"/hubs/{subdomain}/access_restriction/global_password","summary":"Update Hub password settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put","deprecated":false},{"title":"/hubs/{subdomain}/access_restriction/domains_whitelist","summary":"Retrieve domain-based restriction details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get","deprecated":false},{"title":"/hubs/{subdomain}/access_restriction/domains_whitelist","summary":"Update Hub domain-based restrictions","prefix":{"name":"put","color":"put"},"badges":[],"link":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put","deprecated":false},{"title":"/hubs/{subdomain}/access_restriction/ip_whitelist","summary":"Retrieve ip-based restriction details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get","deprecated":false},{"title":"/hubs/{subdomain}/access_restriction/ip_whitelist","summary":"Update Hub ip-based restrictions","prefix":{"name":"put","color":"put"},"badges":[],"link":"/hub-privacy/paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Assets","link":"/api-v3-openapi/assets","routeSlug":"/api-v3-openapi/assets","items":[{"label":"Upload an asset","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/assets/paths/~1hubs~1{subdomain}~1assets/post","routeSlug":"/api-v3-openapi/assets/paths/~1hubs~1{subdomain}~1assets/post","metadata":{"seo":{"title":"Upload an asset","description":"Uploads an asset for existing Hub.Currently supported assets are:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Upload an asset","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1assets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload an asset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploads an asset for existing Hub."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently supported assets are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Logo,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Favicon."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1assets/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1assets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/AssetPayload"}},"schemaId":"components/schemas/AssetPayload","pointer":"/paths/~1hubs~1{subdomain}~1assets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/assets","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/AssetPayload"}},"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/assets","href":"assets/paths/~1hubs~1{subdomain}~1assets/post","summary":"Upload an asset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/AssetPayload","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/AssetPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Asset created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetDetails"}},"schemaId":"components/schemas/AssetDetails"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/422/content/application~1json/examples/Invalid image type","paths/~1hubs~1{subdomain}~1assets/post/responses/422/content/application~1json/examples/Not-square favicon image"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/422/content/application~1json/examples/Invalid image type","paths/~1hubs~1{subdomain}~1assets/post/responses/422/content/application~1json/examples/Not-square favicon image"]}],"pointer":"/paths/~1hubs~1{subdomain}~1assets/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssetDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssetDetails"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/422/content/application~1json/examples/Invalid image type","paths/~1hubs~1{subdomain}~1assets/post/responses/422/content/application~1json/examples/Not-square favicon image"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets/post/responses/422/content/application~1json/examples/Invalid image type","paths/~1hubs~1{subdomain}~1assets/post/responses/422/content/application~1json/examples/Not-square favicon image"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/paths/~1hubs~1{subdomain}~1assets/post"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/assets"},{"label":"Delete an asset","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/assets/paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete","routeSlug":"/api-v3-openapi/assets/paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete","metadata":{"seo":{"title":"Delete an asset","description":"Deletes an asset for current Hub. This method can be used to remove for example Logo from a Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete an asset","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an asset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an asset for current Hub. This method can be used to remove for example Logo from a Hub.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"asset_id","in":"path","schemaId":"schema_42","description":"Unique identifier for the asset.","required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hubs/{subdomain}/assets/{asset_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"asset_id","in":"path","required":true,"schemaId":"schema_42"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/assets/{asset_id}","href":"assets/paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete","summary":"Delete an asset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/200/content/application~1json/examples/OK"]}},"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/200/content/application~1json/examples/OK"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/200/content/application~1json/examples/OK"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/200/content/application~1json/examples/OK"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/assets/{asset_id}"}],"content":{"contentType":"group","meta":{"name":"Assets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assets","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asset is a generic record that typically represents binary data"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"like image that can be referenced and used in other records."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example a Hub logo or favicon."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/assets","summary":"Upload an asset","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/paths/~1hubs~1{subdomain}~1assets/post","deprecated":false},{"title":"/hubs/{subdomain}/assets/{asset_id}","summary":"Delete an asset","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/assets/paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Group","link":"/api-v3-openapi/group","routeSlug":"/api-v3-openapi/group","items":[{"label":"List Groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/group/listgroups","routeSlug":"/api-v3-openapi/group/listgroups","metadata":{"seo":{"title":"List Groups","description":"Filters and returns Groups for current Hub. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGroups","name":"List Groups","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters and returns Groups for current Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1groups/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"archived","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters groups by archived status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only groups that were archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only groups that were not archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return groups without filtering by archived status."},"children":[]}]}]}]}]},{"name":"deleted","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters groups by deletion status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only groups that were deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only groups that were not deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return groups without filtering by deleted status."},"children":[]}]}]}]}]},{"name":"q","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String that filters groups to those containing the search string in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"sort_prop","in":"query","schemaId":"schema_43","description":"Determines which property results should be sorted by.\n"},{"name":"sort_dir","in":"query","schemaId":"schema_29","description":"Determines sorting direction."},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/groups","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"archived","in":"query","schemaId":"schema_2"},{"name":"deleted","in":"query","schemaId":"schema_2"},{"name":"q","in":"query","schemaId":"components/schemas/components-Name"},{"name":"sort_prop","in":"query","schemaId":"schema_43"},{"name":"sort_dir","in":"query","schemaId":"schema_29"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/groups","href":"group/listgroups","openApiOperationId":"listGroups","summary":"List Groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}},"schemaId":"schema_44"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1groups/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1groups/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1groups/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_44","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1groups/get/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1groups/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/listgroups"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/groups"},{"label":"Create a Group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/group/creategroup","routeSlug":"/api-v3-openapi/group/creategroup","metadata":{"seo":{"title":"Create a Group","description":"Creates a new group. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGroup","name":"Create a Group","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new group."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1groups/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1groups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/groups_Payload"}},"schemaId":"components/schemas/groups_Payload","pointer":"/paths/~1hubs~1{subdomain}~1groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/groups","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/groups_Payload"}},"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/groups","href":"group/creategroup","openApiOperationId":"createGroup","summary":"Create a Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/groups_Payload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/groups_Payload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}},"schemaId":"schema_45"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/422/content/application~1json/examples/Empty name"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/422/content/application~1json/examples/Empty name"]}],"pointer":"/paths/~1hubs~1{subdomain}~1groups/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_45","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/422/content/application~1json/examples/Empty name"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups/post/responses/422/content/application~1json/examples/Empty name"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/creategroup"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/groups"},{"label":"Retrieve a Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/group/getgroup","routeSlug":"/api-v3-openapi/group/getgroup","metadata":{"seo":{"title":"Retrieve a Group","description":"Returns data about single group. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroup","name":"Retrieve a Group","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns data about single group."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"group_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the group"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/groups/{group_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/groups/{group_id}","href":"group/getgroup","openApiOperationId":"getGroup","summary":"Retrieve a Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}},"schemaId":"schema_45"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid group_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid group_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_45","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid group_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid group_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/getgroup"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/groups/{group_id}"},{"label":"Update a Group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/group/updategroup","routeSlug":"/api-v3-openapi/group/updategroup","metadata":{"seo":{"title":"Update a Group","description":"Updates existing group. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGroup","name":"Update a Group","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates existing group."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"group_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the group"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/groups_Payload"}},"schemaId":"components/schemas/groups_Payload","pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/groups/{group_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/groups_Payload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/groups/{group_id}","href":"group/updategroup","openApiOperationId":"updateGroup","summary":"Update a Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/groups_Payload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/groups_Payload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}},"schemaId":"schema_45"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/403/content/application~1json/examples/Group is archived","paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/403/content/application~1json/examples/Group is archived","paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/422/content/application~1json/examples/Empty name"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/422/content/application~1json/examples/Empty name"]}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_45","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/403/content/application~1json/examples/Group is archived","paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/403/content/application~1json/examples/Group is archived","paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/422/content/application~1json/examples/Empty name"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/422/content/application~1json/examples/Empty name"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/updategroup"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/groups/{group_id}"},{"label":"Delete a Group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/group/deletegroup","routeSlug":"/api-v3-openapi/group/deletegroup","metadata":{"seo":{"title":"Delete a Group","description":"Deletes existing group and all its services.Request valid only in the scope of Primary or Standalone Hub and can'tbe used in the scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGroup","name":"Delete a Group","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes existing group and all its services."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request valid only in the scope of Primary or Standalone Hub and can't"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be used in the scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleting a group also deletes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All services in that group,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events if there are events that after deleting this group with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"its services would be left without any other services."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"group_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the group"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hubs/{subdomain}/groups/{group_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/groups/{group_id}","href":"group/deletegroup","openApiOperationId":"deleteGroup","summary":"Delete a Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/403/content/application~1json/examples/Group is archived"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/403/content/application~1json/examples/Group is archived"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/403/content/application~1json/examples/Group is archived"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/403/content/application~1json/examples/Group is archived"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/deletegroup"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/groups/{group_id}"},{"label":"Archive a Group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/group/archivegroup","routeSlug":"/api-v3-openapi/group/archivegroup","metadata":{"seo":{"title":"Archive a Group","description":"Archives existing group and all its services.Request valid only in scope of Primary or Standalone Hub and can'tbe used in scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archiveGroup","name":"Archive a Group","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive a Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Archives existing group and all its services."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request valid only in scope of Primary or Standalone Hub and can't"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"be used in scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deleting a group also archives:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All services in that group,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events if there are events that after deleting this group with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"its services would be left without any other services."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The difference between deleting and archiving can be summarized by:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both archived and deleted records are not visible on Hub Page,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlike deleted records, archived records are still visible in Control"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Panel but as a read-only records."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"group_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the group"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/groups/{group_id}/archive","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/groups/{group_id}/archive","href":"group/archivegroup","openApiOperationId":"archiveGroup","summary":"Archive a Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/403/content/application~1json/examples/Group is archived","paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/403/content/application~1json/examples/Group is archived","paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/403/content/application~1json/examples/Group is archived","paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/403/content/application~1json/examples/Group is archived","paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/archivegroup"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/groups/{group_id}/archive"},{"label":"Update a Group position","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/group/reordergroup","routeSlug":"/api-v3-openapi/group/reordergroup","metadata":{"seo":{"title":"Update a Group position","description":"Updates position of existing group. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reorderGroup","name":"Update a Group position","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Group position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates position of existing group."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"group_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the group"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_47"}},"schemaId":"schema_47","pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/groups/{group_id}/reorder","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_47"}},"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/groups/{group_id}/reorder","href":"group/reordergroup","openApiOperationId":"reorderGroup","summary":"Update a Group position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"schema_47","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_47"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/403/content/application~1json/examples/Group is archived","paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/403/content/application~1json/examples/Group is archived","paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid service_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid service_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/403/content/application~1json/examples/Group is archived","paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/403/content/application~1json/examples/Group is archived","paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid service_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid service_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/reordergroup"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/groups/{group_id}/reorder"}],"content":{"contentType":"group","meta":{"name":"Group"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Group","showPageActions":true},{"nodeType":"markdoc","content":"Group purpose is to group Services in logical groups."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/groups","summary":"List Groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/group/listgroups","deprecated":false},{"title":"/hubs/{subdomain}/groups","summary":"Create a Group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/group/creategroup","deprecated":false},{"title":"/hubs/{subdomain}/groups/{group_id}","summary":"Retrieve a Group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/group/getgroup","deprecated":false},{"title":"/hubs/{subdomain}/groups/{group_id}","summary":"Update a Group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/group/updategroup","deprecated":false},{"title":"/hubs/{subdomain}/groups/{group_id}","summary":"Delete a Group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/group/deletegroup","deprecated":false},{"title":"/hubs/{subdomain}/groups/{group_id}/archive","summary":"Archive a Group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/group/archivegroup","deprecated":false},{"title":"/hubs/{subdomain}/groups/{group_id}/reorder","summary":"Update a Group position","prefix":{"name":"put","color":"put"},"badges":[],"link":"/group/reordergroup","deprecated":false}]}]}]}]}},{"type":"group","label":"Service","link":"/api-v3-openapi/service","routeSlug":"/api-v3-openapi/service","items":[{"label":"List Services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/service/listservices","routeSlug":"/api-v3-openapi/service/listservices","metadata":{"seo":{"title":"List Services","description":"Filters and returns services for current Hub. Can return services from all groups. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listServices","name":"List Services","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1services/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters and returns services for current Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can return services from all groups."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1services/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"group_id","in":"query","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters services to only those which belong to group with ID specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"archived","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters services by archived status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only services that were archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only services that were not archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return services without filtering by archived status."},"children":[]}]}]}]}]},{"name":"deleted","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters services by deletion status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only services that were deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only services that were not deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return services without filtering by deleted status."},"children":[]}]}]}]}]},{"name":"q","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String that filters services to those containing the search string in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"per_group_sort","in":"query","schemaId":"schema_48","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alters behavior of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(default) If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sort by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in each connected group individually,"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sort by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" globally so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"output will contain connected services ignoring the order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of connected groups."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This means that connected services from same connected group"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"may be interleaved by connected services from different"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"connected groups."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One exception is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which forces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" regardless of actual value used in request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the order of connected groups"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is always determined by connected group "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}]}]},{"name":"sort_prop","in":"query","schemaId":"schema_43","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines which property results should be sorted by."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The final sorting depends also on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(default) If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sort by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in each group individually,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sort by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" globally so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"output will contain services ignoring the order of group."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This means that services from same group may be interleaved by services"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from different groups."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One exception is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which forces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" regardless of actual value used in request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the order of groups is always determined"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by group "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"name":"sort_dir","in":"query","schemaId":"schema_29","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines sorting direction inside each Group."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It does not affect the order of groups which is fixed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Services will be sorted  by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" inside each group individually."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1services/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/services","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"group_id","in":"query","required":false,"schemaId":"schema_46"},{"name":"archived","in":"query","schemaId":"schema_2"},{"name":"deleted","in":"query","schemaId":"schema_2"},{"name":"q","in":"query","schemaId":"components/schemas/components-Name"},{"name":"per_group_sort","in":"query","schemaId":"schema_48"},{"name":"sort_prop","in":"query","schemaId":"schema_43"},{"name":"sort_dir","in":"query","schemaId":"schema_29"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/services","href":"service/listservices","openApiOperationId":"listServices","summary":"List Services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1services/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1services/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1services/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1services/get/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1services/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service/listservices"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/services"},{"label":"Create a Service","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/service/createservice","routeSlug":"/api-v3-openapi/service/createservice","metadata":{"seo":{"title":"Create a Service","description":"Creates a new service in a group. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createService","name":"Create a Service","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1services/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new service in a group."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1services/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1services/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/services_Payload"}},"schemaId":"components/schemas/services_Payload","pointer":"/paths/~1hubs~1{subdomain}~1services/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/services","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/services_Payload"}},"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/services","href":"service/createservice","openApiOperationId":"createService","summary":"Create a Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/services_Payload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/services_Payload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services/post/responses/404/content/application~1json/examples/Invalid service_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services/post/responses/404/content/application~1json/examples/Invalid service_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/422/content/application~1json/examples/Empty name"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/422/content/application~1json/examples/Empty name"]}],"pointer":"/paths/~1hubs~1{subdomain}~1services/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services/post/responses/404/content/application~1json/examples/Invalid service_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services/post/responses/404/content/application~1json/examples/Invalid service_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/422/content/application~1json/examples/Empty name"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services/post/responses/422/content/application~1json/examples/Empty name"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service/createservice"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/services"},{"label":"Retrieve a Service","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/service/getservice","routeSlug":"/api-v3-openapi/service/getservice","metadata":{"seo":{"title":"Retrieve a Service","description":"Returns data about single service. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getService","name":"Retrieve a Service","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns data about single service."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"service_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the service"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/services/{service_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/services/{service_id}","href":"service/getservice","openApiOperationId":"getService","summary":"Retrieve a Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid service_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid service_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid service_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid service_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service/getservice"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/services/{service_id}"},{"label":"Update a Service","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/service/updateservice","routeSlug":"/api-v3-openapi/service/updateservice","metadata":{"seo":{"title":"Update a Service","description":"Updates data of a service. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateService","name":"Update a Service","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates data of a service."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"service_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the service"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/services_UpdatePayload"}},"schemaId":"components/schemas/services_UpdatePayload","pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/services/{service_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/services_UpdatePayload"}},"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/services/{service_id}","href":"service/updateservice","openApiOperationId":"updateService","summary":"Update a Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/services_UpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/services_UpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/404/content/application~1json/examples/Invalid service_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/404/content/application~1json/examples/Invalid service_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type","paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/422/content/application~1json/examples/Empty name"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type","paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/422/content/application~1json/examples/Empty name"]}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/404/content/application~1json/examples/Invalid service_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/404/content/application~1json/examples/Invalid service_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type","paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/422/content/application~1json/examples/Empty name"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type","paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/422/content/application~1json/examples/Empty name"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service/updateservice"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/services/{service_id}"},{"label":"Delete a Service","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/service/deleteservice","routeSlug":"/api-v3-openapi/service/deleteservice","metadata":{"seo":{"title":"Delete a Service","description":"Deletes a service. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub. Deletion is a soft deletion, service can be restored later."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteService","name":"Delete a Service","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a service."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deletion is a soft deletion, service can be restored later."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"service_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the service"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hubs/{subdomain}/services/{service_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/services/{service_id}","href":"service/deleteservice","openApiOperationId":"deleteService","summary":"Delete a Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/403/content/application~1json/examples/Service is archived"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/403/content/application~1json/examples/Service is archived"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid service_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid service_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/403/content/application~1json/examples/Service is archived"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/403/content/application~1json/examples/Service is archived"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid service_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid service_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service/deleteservice"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/services/{service_id}"},{"label":"Archive a Service","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/service/archiveservice","routeSlug":"/api-v3-openapi/service/archiveservice","metadata":{"seo":{"title":"Archive a Service","description":"Archives a service. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub. Archived services are not returned by index endpoint unless archived parameter is set to true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archiveService","name":"Archive a Service","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive a Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Archives a service."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived services are not returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"service_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the service"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/services/{service_id}/archive","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/services/{service_id}/archive","href":"service/archiveservice","openApiOperationId":"archiveService","summary":"Archive a Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/404/content/application~1json/examples/Invalid service_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/404/content/application~1json/examples/Invalid service_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/404/content/application~1json/examples/Invalid service_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/404/content/application~1json/examples/Invalid service_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service/archiveservice"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/services/{service_id}/archive"},{"label":"Update a Service position","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/service/reorderservice","routeSlug":"/api-v3-openapi/service/reorderservice","metadata":{"seo":{"title":"Update a Service position","description":"Updates position of a service in a group. Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reorderService","name":"Update a Service position","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Service position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates position of a service in a group."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Primary or Standalone Hub and can't be used in scope of a Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"service_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the service"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51","pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/services/{service_id}/reorder","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_51"}},"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/services/{service_id}/reorder","href":"service/reorderservice","openApiOperationId":"reorderService","summary":"Update a Service position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_51"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid service_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid service_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid service_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid service_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service/reorderservice"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/services/{service_id}/reorder"}],"content":{"contentType":"group","meta":{"name":"Service"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Service","showPageActions":true},{"nodeType":"markdoc","content":"Service represents fundamental Hub entity. Incident and Maintenance events\nare always attached to at least one Service. Service status should\nrepresent the health of the actual real-life entity it represents."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/services","summary":"List Services","prefix":{"name":"get","color":"get"},"badges":[],"link":"/service/listservices","deprecated":false},{"title":"/hubs/{subdomain}/services","summary":"Create a Service","prefix":{"name":"post","color":"post"},"badges":[],"link":"/service/createservice","deprecated":false},{"title":"/hubs/{subdomain}/services/{service_id}","summary":"Retrieve a Service","prefix":{"name":"get","color":"get"},"badges":[],"link":"/service/getservice","deprecated":false},{"title":"/hubs/{subdomain}/services/{service_id}","summary":"Update a Service","prefix":{"name":"put","color":"put"},"badges":[],"link":"/service/updateservice","deprecated":false},{"title":"/hubs/{subdomain}/services/{service_id}","summary":"Delete a Service","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/service/deleteservice","deprecated":false},{"title":"/hubs/{subdomain}/services/{service_id}/archive","summary":"Archive a Service","prefix":{"name":"put","color":"put"},"badges":[],"link":"/service/archiveservice","deprecated":false},{"title":"/hubs/{subdomain}/services/{service_id}/reorder","summary":"Update a Service position","prefix":{"name":"put","color":"put"},"badges":[],"link":"/service/reorderservice","deprecated":false}]}]}]}]}},{"type":"group","label":"Service Integration","link":"/api-v3-openapi/service-integration","routeSlug":"/api-v3-openapi/service-integration","items":[{"label":"List service integrations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/service-integration/listserviceintegrations","routeSlug":"/api-v3-openapi/service-integration/listserviceintegrations","metadata":{"seo":{"title":"List service integrations","description":"List all of available integrations for a service.Integration version is used to indicate the generation of integrationswhere v1 are the basic integrations available in StatusHub for long time.while v2 integrations are much more capable and all newly introducedintegrations will be added in v2 version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listServiceIntegrations","name":"List service integrations","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List service integrations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all of available integrations for a service."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integration version is used to indicate the generation of integrations"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the basic integrations available in StatusHub for long time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations are much more capable and all newly introduced"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations will be added in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" version."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"service_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the service"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"enabled","in":"query","schemaId":"schema_52","description":"Filter by enabled status"},{"name":"version","in":"query","schemaId":"schema_53","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by integration version."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently available versions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - basic integrations available in StatusHub for long time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - more capable integrations. All newly introduced"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations will be added in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" version."},"children":[]}]}]}]}]},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/services/{service_id}/integrations","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"enabled","in":"query","schemaId":"schema_52"},{"name":"version","in":"query","schemaId":"schema_53"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/services/{service_id}/integrations","href":"service-integration/listserviceintegrations","openApiOperationId":"listServiceIntegrations","summary":"List service integrations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54"}},"schemaId":"schema_54"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_54","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service-integration/listserviceintegrations"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/services/{service_id}/integrations"},{"label":"Retrieve a service integration details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/service-integration/showserviceintegration","routeSlug":"/api-v3-openapi/service-integration/showserviceintegration","metadata":{"seo":{"title":"Retrieve a service integration details","description":"Show service integration details With the exception of Pingdom integration, all other integrations are using per-service URL for connection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"showServiceIntegration","name":"Retrieve a service integration details","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a service integration details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Show service integration details\nWith the exception of Pingdom integration, all other integrations are\nusing per-service URL for connection.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"service_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the service"},"children":[]}]}]}],"required":true},{"name":"integration_slug","in":"path","schemaId":"schema_55","description":"Integration slug","required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/services/{service_id}/integrations/{integration_slug}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_46"},{"name":"integration_slug","in":"path","required":true,"schemaId":"schema_55"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/services/{service_id}/integrations/{integration_slug}","href":"service-integration/showserviceintegration","openApiOperationId":"showServiceIntegration","summary":"Retrieve a service integration details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}},"schemaId":"schema_56"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_56","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service-integration/showserviceintegration"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/services/{service_id}/integrations/{integration_slug}"},{"label":"Update service integrations","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/service-integration/updateserviceintegration","routeSlug":"/api-v3-openapi/service-integration/updateserviceintegration","metadata":{"seo":{"title":"Update service integrations","description":"Update service integrations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateServiceIntegration","name":"Update service integrations","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update service integrations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update service integrations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"service_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the service"},"children":[]}]}]}],"required":true},{"name":"integration_slug","in":"path","schemaId":"schema_55","description":"Integration slug","required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/integrations_UpdatePayload"}},"schemaId":"components/schemas/integrations_UpdatePayload","pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/services/{service_id}/integrations/{integration_slug}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_46"},{"name":"integration_slug","in":"path","required":true,"schemaId":"schema_55"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/integrations_UpdatePayload"}},"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/services/{service_id}/integrations/{integration_slug}","href":"service-integration/updateserviceintegration","openApiOperationId":"updateServiceIntegration","summary":"Update service integrations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/integrations_UpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/integrations_UpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}},"schemaId":"schema_56"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_56","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service-integration/updateserviceintegration"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/services/{service_id}/integrations/{integration_slug}"}],"content":{"contentType":"group","meta":{"name":"Service Integration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Service Integration","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service Integration allows creation automation that creates events"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in StatusHub from various 3rd party applications."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As opposed to StatusHub Management API, those integrations endpoints"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are simplified and doesn't allow reading any data."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most of integrations use per-service token for authorization."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/services/{service_id}/integrations","summary":"List service integrations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/service-integration/listserviceintegrations","deprecated":false},{"title":"/hubs/{subdomain}/services/{service_id}/integrations/{integration_slug}","summary":"Retrieve a service integration details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/service-integration/showserviceintegration","deprecated":false},{"title":"/hubs/{subdomain}/services/{service_id}/integrations/{integration_slug}","summary":"Update service integrations","prefix":{"name":"put","color":"put"},"badges":[],"link":"/service-integration/updateserviceintegration","deprecated":false}]}]}]}]}},{"type":"group","label":"Connected Group","link":"/api-v3-openapi/connected-group","routeSlug":"/api-v3-openapi/connected-group","items":[{"label":"List Connected Groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/connected-group/listconnectedgroups","routeSlug":"/api-v3-openapi/connected-group/listconnectedgroups","metadata":{"seo":{"title":"List Connected Groups","description":"Filters and returns Connected Groups for current Hub. Request valid only in scope of Connected Hub and can't be used in scope of a Primary or Standalone Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listConnectedGroups","name":"List Connected Groups","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1connected_groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Connected Groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters and returns Connected Groups for current Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Connected Hub and can't be used in scope of a Primary or Standalone Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_groups/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"archived","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters groups by archived status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only groups that were archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only groups that were not archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return groups without filtering by archived status."},"children":[]}]}]}]}]},{"name":"deleted","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters groups by deletion status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only groups that were deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only groups that were not deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return groups without filtering by deleted status."},"children":[]}]}]}]}]},{"name":"q","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String that filters groups to those containing the search string in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"sort_prop","in":"query","schemaId":"schema_43","description":"Determines which property results should be sorted by.\n"},{"name":"sort_dir","in":"query","schemaId":"schema_29","description":"Determines sorting direction."},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/connected_groups","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"archived","in":"query","schemaId":"schema_2"},{"name":"deleted","in":"query","schemaId":"schema_2"},{"name":"q","in":"query","schemaId":"components/schemas/components-Name"},{"name":"sort_prop","in":"query","schemaId":"schema_43"},{"name":"sort_dir","in":"query","schemaId":"schema_29"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/connected_groups","href":"connected-group/listconnectedgroups","openApiOperationId":"listConnectedGroups","summary":"List Connected Groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}},"schemaId":"schema_44"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1connected_groups/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1connected_groups/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_groups/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_44","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1connected_groups/get/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1connected_groups/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connected-group/listconnectedgroups"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/connected_groups"},{"label":"Retrieve a Connected Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/connected-group/getconnectedgroup","routeSlug":"/api-v3-openapi/connected-group/getconnectedgroup","metadata":{"seo":{"title":"Retrieve a Connected Group","description":"Returns data about single Connected Group. Request valid only in scope of Connected Hub and can't be used in scope of a Primary or Standalone Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConnectedGroup","name":"Retrieve a Connected Group","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Connected Group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns data about single Connected Group."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Connected Hub and can't be used in scope of a Primary or Standalone Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"group_id","in":"path","schemaId":"schema_46","description":"ID of Group","required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/connected_groups/{group_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/connected_groups/{group_id}","href":"connected-group/getconnectedgroup","openApiOperationId":"getConnectedGroup","summary":"Retrieve a Connected Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}},"schemaId":"schema_45"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid incident_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid incident_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_45","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid incident_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid incident_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connected-group/getconnectedgroup"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/connected_groups/{group_id}"}],"content":{"contentType":"group","meta":{"name":"Connected Group"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Connected Group","showPageActions":true},{"nodeType":"markdoc","content":"Connected Group is a special representation of actual Group that through\nits Services is attached to Connected Hub."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/connected_groups","summary":"List Connected Groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/connected-group/listconnectedgroups","deprecated":false},{"title":"/hubs/{subdomain}/connected_groups/{group_id}","summary":"Retrieve a Connected Group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/connected-group/getconnectedgroup","deprecated":false}]}]}]}]}},{"type":"group","label":"Connected Service","link":"/api-v3-openapi/connected-service","routeSlug":"/api-v3-openapi/connected-service","items":[{"label":"List Connected Services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/connected-service/listconnectedservices","routeSlug":"/api-v3-openapi/connected-service/listconnectedservices","metadata":{"seo":{"title":"List Connected Services","description":"Filters and returns Connected Services for current Hub. Request valid only in scope of Connected Hub and can't be used in scope of a Primary or Standalone Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listConnectedServices","name":"List Connected Services","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1connected_services/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Connected Services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters and returns Connected Services for current Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Connected Hub and can't be used in scope of a Primary or Standalone Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_services/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"group_id","in":"query","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters services to only those which belong to group with ID specified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"archived","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters services by archived status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only services that were archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only services that were not archived,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return services without filtering by archived status."},"children":[]}]}]}]}]},{"name":"deleted","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters services by deletion status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only services that were deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only services that were not deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return services without filtering by deleted status."},"children":[]}]}]}]}]},{"name":"q","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String that filters services to those containing the search string in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"per_group_sort","in":"query","schemaId":"schema_48","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alters behavior of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(default) If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sort by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in each connected group individually,"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sort by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" globally so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"output will contain connected services ignoring the order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of connected groups."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This means that connected services from same connected group"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"may be interleaved by connected services from different"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"connected groups."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One exception is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which forces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" regardless of actual value used in request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the order of connected groups"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is always determined by connected group "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}]}]},{"name":"sort_prop","in":"query","schemaId":"schema_43","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines which property results should be sorted by."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The final sorting depends also on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(default) If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sort by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in each connected group individually,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Sort by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" globally so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"output will contain connected services ignoring the order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of connected groups."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This means that connected services from same connected group"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"may be interleaved by connected services from different"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"connected groups."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One exception is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which forces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" regardless of actual value used in request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_group_sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the order of connected groups"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is always determined by connected group "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"name":"sort_dir","in":"query","schemaId":"schema_29","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines sorting direction inside each Group."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It does not affect the order of groups which is fixed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Services will be sorted  by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" inside each group individually."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_services/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/connected_services","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"group_id","in":"query","required":false,"schemaId":"schema_46"},{"name":"archived","in":"query","schemaId":"schema_2"},{"name":"deleted","in":"query","schemaId":"schema_2"},{"name":"q","in":"query","schemaId":"components/schemas/components-Name"},{"name":"per_group_sort","in":"query","schemaId":"schema_48"},{"name":"sort_prop","in":"query","schemaId":"schema_43"},{"name":"sort_dir","in":"query","schemaId":"schema_29"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/connected_services","href":"connected-service/listconnectedservices","openApiOperationId":"listConnectedServices","summary":"List Connected Services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1connected_services/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1connected_services/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_services/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1connected_services/get/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/get/responses/422/content/application~1json/examples/Invalid deleted param","paths/~1hubs~1{subdomain}~1connected_services/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connected-service/listconnectedservices"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/connected_services"},{"label":"Create a Connected Service","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/connected-service/createconnectedservice","routeSlug":"/api-v3-openapi/connected-service/createconnectedservice","metadata":{"seo":{"title":"Create a Connected Service","description":"Creates a new Connected Service. Request valid only in the scope of Connected Hub and can't be used in the scope of a Primary or Standalone Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createConnectedService","name":"Create a Connected Service","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1connected_services/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Connected Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Connected Service."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in the scope of Connected Hub and can't be used in the scope of a Primary or Standalone Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_services/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_services/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/connected_services_Payload"}},"schemaId":"components/schemas/connected_services_Payload","pointer":"/paths/~1hubs~1{subdomain}~1connected_services/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/connected_services","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/connected_services_Payload"}},"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/connected_services","href":"connected-service/createconnectedservice","openApiOperationId":"createConnectedService","summary":"Create a Connected Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/connected_services_Payload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/connected_services_Payload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_services/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services/post/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connected-service/createconnectedservice"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/connected_services"},{"label":"Retrieve a Connected Service","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/connected-service/getconnectedservice","routeSlug":"/api-v3-openapi/connected-service/getconnectedservice","metadata":{"seo":{"title":"Retrieve a Connected Service","description":"Returns data about single Connected Service. Request valid only in scope of Connected Hub and can't be used in scope of a Primary or Standalone Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConnectedService","name":"Retrieve a Connected Service","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Connected Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns data about single Connected Service."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in scope of Connected Hub and can't be used in scope of a Primary or Standalone Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"service_id","in":"path","schemaId":"schema_46","description":"ID of Service","required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/connected_services/{service_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/connected_services/{service_id}","href":"connected-service/getconnectedservice","openApiOperationId":"getConnectedService","summary":"Retrieve a Connected Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connected-service/getconnectedservice"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/connected_services/{service_id}"},{"label":"Delete a Connected Service","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/connected-service/deleteconnectedservice","routeSlug":"/api-v3-openapi/connected-service/deleteconnectedservice","metadata":{"seo":{"title":"Delete a Connected Service","description":"Deletes a Connected Service. Request valid only in the scope of Connected Hub and can't be used in the scope of a Primary or Standalone Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteConnectedService","name":"Delete a Connected Service","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Connected Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a Connected Service."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Request valid only in the scope of Connected Hub and can't be used in the scope of a Primary or Standalone Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"service_id","in":"path","schemaId":"schema_46","description":"ID of Service","required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hubs/{subdomain}/connected_services/{service_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/connected_services/{service_id}","href":"connected-service/deleteconnectedservice","openApiOperationId":"deleteConnectedService","summary":"Delete a Connected Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid service_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid service_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"]}],"pointer":"/paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid service_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid service_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/connected-service/deleteconnectedservice"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/connected_services/{service_id}"}],"content":{"contentType":"group","meta":{"name":"Connected Service"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Connected Service","showPageActions":true},{"nodeType":"markdoc","content":"Connected Service is a special representation of actual Service that\nis attached to Connected Hub."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/connected_services","summary":"List Connected Services","prefix":{"name":"get","color":"get"},"badges":[],"link":"/connected-service/listconnectedservices","deprecated":false},{"title":"/hubs/{subdomain}/connected_services","summary":"Create a Connected Service","prefix":{"name":"post","color":"post"},"badges":[],"link":"/connected-service/createconnectedservice","deprecated":false},{"title":"/hubs/{subdomain}/connected_services/{service_id}","summary":"Retrieve a Connected Service","prefix":{"name":"get","color":"get"},"badges":[],"link":"/connected-service/getconnectedservice","deprecated":false},{"title":"/hubs/{subdomain}/connected_services/{service_id}","summary":"Delete a Connected Service","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/connected-service/deleteconnectedservice","deprecated":false}]}]}]}]}},{"type":"group","label":"External Application","link":"/api-v3-openapi/external-application","routeSlug":"/api-v3-openapi/external-application","items":[{"label":"List External Application installations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/external-application/listexternalapplications","routeSlug":"/api-v3-openapi/external-application/listexternalapplications","metadata":{"seo":{"title":"List External Application installations","description":"List all of currently supported external applications as well as thestatus of the integration for current Hub.If app is not enabled, it will not work even if its installed with correcttoken.Currently supported applications are:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listExternalApplications","name":"List External Application installations","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1external_applications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List External Application installations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all of currently supported external applications as well as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status of the integration for current Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If app is not enabled, it will not work even if its installed with correct"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently supported applications are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimal Widget - Small and basic version of StatusHub widget"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"intended to be used in places requiring small visual size of the widget,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Widget - Default Statushub widget,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zendesk - StatusHub App for Zendesk -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zendesk.com/marketplace/apps/support/127482/statushub/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zendesk Marketplace link"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1external_applications/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1external_applications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/external_applications","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/external_applications","href":"external-application/listexternalapplications","openApiOperationId":"listExternalApplications","summary":"List External Application installations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications/get/responses/404/content/application~1json/examples/Invalid subdomain"]}],"pointer":"/paths/~1hubs~1{subdomain}~1external_applications/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_57"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-application/listexternalapplications"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/external_applications"},{"label":"Retrieve an external application installation details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/external-application/getexternalapplication","routeSlug":"/api-v3-openapi/external-application/getexternalapplication","metadata":{"seo":{"title":"Retrieve an external application installation details","description":"Show details of a specific External Application installation.For security reasons, token is not returned. If app token is lost,in Management API v3 the only way to retrieve a token is to generatea new one with reset token operation.In order to install the application, please refer to documentation ofrespective CP2 which will contain all necessary snippets and links."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExternalApplication","name":"Retrieve an external application installation details","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an external application installation details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show details of a specific External Application installation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For security reasons, token is not returned. If app token is lost,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in Management API v3 the only way to retrieve a token is to generate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a new one with reset token operation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to install the application, please refer to documentation of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"respective CP2 which will contain all necessary snippets and links."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"external_application_slug","in":"path","schemaId":"schema_58","description":"External Application slug","required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/external_applications/{external_application_slug}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"external_application_slug","in":"path","required":true,"schemaId":"schema_58"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/external_applications/{external_application_slug}","href":"external-application/getexternalapplication","openApiOperationId":"getExternalApplication","summary":"Retrieve an external application installation details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59"}},"schemaId":"schema_59"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}],"pointer":"/paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_59","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-application/getexternalapplication"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/external_applications/{external_application_slug}"},{"label":"Update an External Application installation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/external-application/updateexternalapplication","routeSlug":"/api-v3-openapi/external-application/updateexternalapplication","metadata":{"seo":{"title":"Update an External Application installation","description":"Updates External Application installation.Currently the only allowed operation is to enable or disable the app."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateExternalApplication","name":"Update an External Application installation","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an External Application installation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates External Application installation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently the only allowed operation is to enable or disable the app."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"external_application_slug","in":"path","schemaId":"schema_58","description":"External Application slug","required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/external_applications_Payload"}},"schemaId":"components/schemas/external_applications_Payload","pointer":"/paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/external_applications/{external_application_slug}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"external_application_slug","in":"path","required":true,"schemaId":"schema_58"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/external_applications_Payload"}},"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/external_applications/{external_application_slug}","href":"external-application/updateexternalapplication","openApiOperationId":"updateExternalApplication","summary":"Update an External Application installation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/external_applications_Payload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/external_applications_Payload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59"}},"schemaId":"schema_59"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_59","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-application/updateexternalapplication"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/external_applications/{external_application_slug}"},{"label":"Reset External Application token","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/external-application/resetexternalapplicationtoken","routeSlug":"/api-v3-openapi/external-application/resetexternalapplicationtoken","metadata":{"seo":{"title":"Reset External Application token","description":"Resets the token for an External Application installation.This is the only way to obtain app token through Management API v3.Resetting the token is automatically invalidating previously used tokenand that operation is unreverisble. Can be used to quickly disablethe app if for example token has been compromised."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resetExternalApplicationToken","name":"Reset External Application token","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset External Application token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resets the token for an External Application installation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the only way to obtain app token through Management API v3."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resetting the token is automatically invalidating previously used token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and that operation is unreverisble. Can be used to quickly disable"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the app if for example token has been compromised."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"external_application_slug","in":"path","schemaId":"schema_58","description":"External Application slug","required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/external_applications/{external_application_slug}/reset_token","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"external_application_slug","in":"path","required":true,"schemaId":"schema_58"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/external_applications/{external_application_slug}/reset_token","href":"external-application/resetexternalapplicationtoken","openApiOperationId":"resetExternalApplicationToken","summary":"Reset External Application token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60"}},"schemaId":"schema_60"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_60","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-application/resetexternalapplicationtoken"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/external_applications/{external_application_slug}/reset_token"}],"content":{"contentType":"group","meta":{"name":"External Application"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Application","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows managing StatusHub widgets."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently supported applications are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimal Widget - Small and basic version of StatusHub widget"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"intended to be used in places requiring small visual size of the widget,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Widget - Default Statushub widget,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zendesk - StatusHub App for Zendesk -"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.zendesk.com/marketplace/apps/support/127482/statushub/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zendesk Marketplace link"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/external_applications","summary":"List External Application installations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/external-application/listexternalapplications","deprecated":false},{"title":"/hubs/{subdomain}/external_applications/{external_application_slug}","summary":"Retrieve an external application installation details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/external-application/getexternalapplication","deprecated":false},{"title":"/hubs/{subdomain}/external_applications/{external_application_slug}","summary":"Update an External Application installation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/external-application/updateexternalapplication","deprecated":false},{"title":"/hubs/{subdomain}/external_applications/{external_application_slug}/reset_token","summary":"Reset External Application token","prefix":{"name":"put","color":"put"},"badges":[],"link":"/external-application/resetexternalapplicationtoken","deprecated":false}]}]}]}]}},{"type":"group","label":"Uptime","link":"/api-v3-openapi/uptime","routeSlug":"/api-v3-openapi/uptime","items":[{"label":"Retrieve Hub uptime value","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/uptime/getuptime","routeSlug":"/api-v3-openapi/uptime/getuptime","metadata":{"seo":{"title":"Retrieve Hub uptime value","description":"Returns uptime for a Hub which is based on uptime of all servicesin that Hub for a given date range.Hub is considered up if all of its services are not down.Every time frame when at least one of Hub services is down, is consideredas downtime for this Hub.Maximum length of date range is 18 months."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUptime","name":"Retrieve Hub uptime value","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1uptime/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Hub uptime value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns uptime for a Hub which is based on uptime of all services"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in that Hub for a given date range."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub is considered up if all of its services are not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"down"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every time frame when at least one of Hub services is down, is considered"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as downtime for this Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum length of date range is 18 months."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1uptime/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"components/schemas/Date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date for uptime calculations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range can't be bigger than 18 months."},"children":[]}]}]}]},{"name":"end_date","in":"query","schemaId":"components/schemas/Date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date for uptime calculations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range can't be bigger than 18 months."},"children":[]}]}]}]},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1uptime/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/uptime","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"start_date","in":"query","example":"2025-01-01","schemaId":"components/schemas/Date"},{"name":"end_date","in":"query","example":"2025-01-01","schemaId":"components/schemas/Date"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/uptime","href":"uptime/getuptime","openApiOperationId":"getUptime","summary":"Retrieve Hub uptime value"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}},"schemaId":"schema_61"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime/get/responses/422/content/application~1json/examples/start and end date too far apart"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime/get/responses/422/content/application~1json/examples/start and end date too far apart"]}],"pointer":"/paths/~1hubs~1{subdomain}~1uptime/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_61","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime/get/responses/422/content/application~1json/examples/start and end date too far apart"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime/get/responses/422/content/application~1json/examples/start and end date too far apart"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/uptime/getuptime"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/uptime"},{"label":"Returns Hub uptime data with daily granularity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/uptime/getdailyuptime","routeSlug":"/api-v3-openapi/uptime/getdailyuptime","metadata":{"seo":{"title":"Returns Hub uptime data with daily granularity","description":"Returns uptime for a Hub with daily granularity.Hub uptime is based on uptime of all services in that Hub for everyday.Days are aligned to UTC timezone.Hub is considered up for given day if all of its services are not downin that day.Every time frame when at least one of Hub services is down, is consideredas downtime for this Hub.Maximum length of date range is 18 months."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDailyUptime","name":"Returns Hub uptime data with daily granularity","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1uptime~1daily/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns Hub uptime data with daily granularity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns uptime for a Hub with daily granularity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub uptime is based on uptime of all services in that Hub for every"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"day."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Days are aligned to UTC timezone."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub is considered up for given day if all of its services are not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"down"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in that day."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every time frame when at least one of Hub services is down, is considered"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as downtime for this Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum length of date range is 18 months."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1uptime~1daily/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"components/schemas/Date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date for uptime calculations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range can't be bigger than 18 months."},"children":[]}]}]}]},{"name":"end_date","in":"query","schemaId":"components/schemas/Date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date for uptime calculations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range can't be bigger than 18 months."},"children":[]}]}]}]},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1uptime~1daily/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/uptime/daily","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"start_date","in":"query","example":"2025-01-01","schemaId":"components/schemas/Date"},{"name":"end_date","in":"query","example":"2025-01-01","schemaId":"components/schemas/Date"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/uptime/daily","href":"uptime/getdailyuptime","openApiOperationId":"getDailyUptime","summary":"Returns Hub uptime data with daily granularity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DailyUptimeDetails"}},"schemaId":"components/schemas/DailyUptimeDetails"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/422/content/application~1json/examples/start and end date too far apart"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/422/content/application~1json/examples/start and end date too far apart"]}],"pointer":"/paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DailyUptimeDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DailyUptimeDetails"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/422/content/application~1json/examples/start and end date too far apart"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/422/content/application~1json/examples/start and end date too far apart"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/uptime/getdailyuptime"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/uptime/daily"},{"label":"Retrieve group uptime value","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/uptime/getgroupuptime","routeSlug":"/api-v3-openapi/uptime/getgroupuptime","metadata":{"seo":{"title":"Retrieve group uptime value","description":"Returns uptime for a group which is based on uptime of all servicesin that group for a given date range.Group is considered up if all of its services are not down.Every time frame when at least one of group services is down, is consideredas downtime for this group.Maximum length of date range is 18 months."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroupUptime","name":"Retrieve group uptime value","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve group uptime value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns uptime for a group which is based on uptime of all services"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in that group for a given date range."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Group is considered up if all of its services are not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"down"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every time frame when at least one of group services is down, is considered"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as downtime for this group."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum length of date range is 18 months."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"group_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the group"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"components/schemas/Date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date for uptime calculations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range can't be bigger than 18 months."},"children":[]}]}]}]},{"name":"end_date","in":"query","schemaId":"components/schemas/Date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date for uptime calculations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range can't be bigger than 18 months."},"children":[]}]}]}]},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/uptime/groups/{group_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"start_date","in":"query","example":"2025-01-01","schemaId":"components/schemas/Date"},{"name":"end_date","in":"query","example":"2025-01-01","schemaId":"components/schemas/Date"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/uptime/groups/{group_id}","href":"uptime/getgroupuptime","openApiOperationId":"getGroupUptime","summary":"Retrieve group uptime value"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}},"schemaId":"schema_61"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/422/content/application~1json/examples/start and end date too far apart"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/422/content/application~1json/examples/start and end date too far apart"]}],"pointer":"/paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_61","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/422/content/application~1json/examples/start and end date too far apart"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/422/content/application~1json/examples/start and end date too far apart"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/uptime/getgroupuptime"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/uptime/groups/{group_id}"},{"label":"Retrieve service uptime value","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/uptime/getserviceuptime","routeSlug":"/api-v3-openapi/uptime/getserviceuptime","metadata":{"seo":{"title":"Retrieve service uptime value","description":"Returns uptime for a service for a given date range.Service is considered up its status is not down.Maximum length of date range is 18 months."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getServiceUptime","name":"Retrieve service uptime value","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve service uptime value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns uptime for a service for a given date range."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service is considered up its status is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"down"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum length of date range is 18 months."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"service_id","in":"path","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the service"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"components/schemas/Date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date for uptime calculations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range can't be bigger than 18 months."},"children":[]}]}]}]},{"name":"end_date","in":"query","schemaId":"components/schemas/Date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date for uptime calculations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range can't be bigger than 18 months."},"children":[]}]}]}]},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/uptime/services/{service_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_46"}],"query":[{"name":"start_date","in":"query","example":"2025-01-01","schemaId":"components/schemas/Date"},{"name":"end_date","in":"query","example":"2025-01-01","schemaId":"components/schemas/Date"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/uptime/services/{service_id}","href":"uptime/getserviceuptime","openApiOperationId":"getServiceUptime","summary":"Retrieve service uptime value"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}},"schemaId":"schema_61"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/422/content/application~1json/examples/start and end date too far apart"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/422/content/application~1json/examples/start and end date too far apart"]}],"pointer":"/paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_61","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/422/content/application~1json/examples/start and end date too far apart"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid end date","paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/422/content/application~1json/examples/start and end date too far apart"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/uptime/getserviceuptime"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/uptime/services/{service_id}"}],"content":{"contentType":"group","meta":{"name":"Uptime"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Uptime","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns uptime information about:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub with either one value or per-day granularity,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single group,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single service."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uptime is calculated according to following rules:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTC timezone is used,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'degraded-performance' is not counted towards downtime. Only 'down'"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status is treated as time when service was down,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If multiple events affect service in the same time, always worst"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status is being used for uptime calculation,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For group uptime, combination of worst statuses of all services"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in that group is used."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if group has three services and:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One was up for the whole time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Second was down for the whole first half of the period (50%),"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last service was down for the second half of the period (50%),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then group uptime is 0% because there was no time when none of its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"services were down."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Hub uptime, combination of worst statuses of all services of that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub is being used."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/uptime","summary":"Retrieve Hub uptime value","prefix":{"name":"get","color":"get"},"badges":[],"link":"/uptime/getuptime","deprecated":false},{"title":"/hubs/{subdomain}/uptime/daily","summary":"Returns Hub uptime data with daily granularity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/uptime/getdailyuptime","deprecated":false},{"title":"/hubs/{subdomain}/uptime/groups/{group_id}","summary":"Retrieve group uptime value","prefix":{"name":"get","color":"get"},"badges":[],"link":"/uptime/getgroupuptime","deprecated":false},{"title":"/hubs/{subdomain}/uptime/services/{service_id}","summary":"Retrieve service uptime value","prefix":{"name":"get","color":"get"},"badges":[],"link":"/uptime/getserviceuptime","deprecated":false}]}]}]}]}},{"type":"separator","label":"Visitors","content":null},{"type":"group","label":"Subscription","link":"/api-v3-openapi/subscription","routeSlug":"/api-v3-openapi/subscription","items":[{"label":"Create a Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscription/createsubscription","routeSlug":"/api-v3-openapi/subscription/createsubscription","metadata":{"seo":{"title":"Create a Subscription","description":"Creates a new Subscription. Creates Subscriber record as well.Besides regular validation - like address correctness - there area few additional constraints:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubscription","name":"Create a Subscription","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Subscription. Creates Subscriber record as well."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Besides regular validation - like address correctness - there are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a few additional constraints:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address has to be unique for current Hub,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single Subscriber can't have multiple subscriptions with same method name."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example it's not allowed for one Subscriber to have for example"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two email subscriptions."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example","paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection"]}},"schemaId":"components/schemas/CreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example","paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection"],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/subscriptions","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example","paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/subscriptions","href":"subscription/createsubscription","openApiOperationId":"createSubscription","summary":"Create a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/CreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example","paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example","paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated address","paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated method","paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid address"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated address","paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated method","paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid address"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated address","paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated method","paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid address"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated address","paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated method","paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid address"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/createsubscription"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscriptions"},{"label":"List Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscription/listsubscriptions","routeSlug":"/api-v3-openapi/subscription/listsubscriptions","metadata":{"seo":{"title":"List Subscriptions","description":"Filters and returns Subscriptions with basic info for current Hub."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscriptions","name":"List Subscriptions","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Filters and returns Subscriptions with basic info for current Hub.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"deleted","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters subscriptions by deletion status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only subscriptions that were deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only subscriptions that were not deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return subscriptions without filtering by deleted status."},"children":[]}]}]}]}]},{"name":"deleted_after","in":"query","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters Subscriptions by the timestamp of record deletion."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks for Subscriptions deleted on or after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleted_after"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 formatted time (UTC)."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String that filters subscriptions to those containing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the search string in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"extend","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which properties should be expanded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Expanded properties contains more detailed information which is less frequently needed in typical usage."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Currently supported only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort_prop","in":"query","schemaId":"schema_64","description":"Determines which property results should be sorted by."},{"name":"sort_dir","in":"query","schemaId":"schema_4","description":"Determines sorting direction."},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/subscriptions","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"deleted","in":"query","schemaId":"schema_2"},{"name":"deleted_after","in":"query","example":"2020-09-01T08:29:00Z","schemaId":"schema_63"},{"name":"q","in":"query","schemaId":"components/schemas/components-Name"},{"name":"extend","in":"query","example":"flags","schemaId":"schema_7"},{"name":"sort_prop","in":"query","schemaId":"schema_64"},{"name":"sort_dir","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/subscriptions","href":"subscription/listsubscriptions","openApiOperationId":"listSubscriptions","summary":"List Subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}},"schemaId":"schema_65"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscriptions/get/responses/422/content/application~1json/examples/Invalid extend param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscriptions/get/responses/422/content/application~1json/examples/Invalid extend param"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_65","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscriptions/get/responses/422/content/application~1json/examples/Invalid extend param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscriptions/get/responses/422/content/application~1json/examples/Invalid extend param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/listsubscriptions"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscriptions"},{"label":"Retrieve a Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscription/getsubscription","routeSlug":"/api-v3-openapi/subscription/getsubscription","metadata":{"seo":{"title":"Retrieve a Subscription","description":"Returns data about single Subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscription","name":"Retrieve a Subscription","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about single Subscription."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"subscription_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscription to be deleted"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"extend","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which properties should be expanded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Expanded properties contains more detailed information which is less frequently needed in typical usage."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Currently supported only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/subscriptions/{subscription_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"extend","in":"query","example":"flags","schemaId":"schema_7"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/subscriptions/{subscription_id}","href":"subscription/getsubscription","openApiOperationId":"getSubscription","summary":"Retrieve a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscription ID"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscription ID"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscription ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscription ID"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Invalid extend param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/getsubscription"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscriptions/{subscription_id}"},{"label":"Update a Subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscription/updatesubscription","routeSlug":"/api-v3-openapi/subscription/updatesubscription","metadata":{"seo":{"title":"Update a Subscription","description":"Modifies existing Subscription. Only modified attributes may be passed in payload. All other attributes will remain unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSubscription","name":"Update a Subscription","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modifies existing Subscription."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only modified attributes may be passed in payload. All other attributes will remain unchanged."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"subscription_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscription to be deleted"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/subscriptions_UpdatePayload"}},"schemaId":"components/schemas/subscriptions_UpdatePayload","pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/subscriptions/{subscription_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/subscriptions_UpdatePayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/subscriptions/{subscription_id}","href":"subscription/updatesubscription","openApiOperationId":"updateSubscription","summary":"Update a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/subscriptions_UpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/subscriptions_UpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscription ID"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscription ID"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/422/content/application~1json/examples/Missing services selection"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/422/content/application~1json/examples/Missing services selection"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscription ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscription ID"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/422/content/application~1json/examples/Missing services selection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/422/content/application~1json/examples/Missing services selection"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/updatesubscription"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscriptions/{subscription_id}"},{"label":"Delete a Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscription/deletesubscription","routeSlug":"/api-v3-openapi/subscription/deletesubscription","metadata":{"seo":{"title":"Delete a Subscription","description":"Deletes Subscription record. Records are soft-deleted which means that such deleted record can still be viewed and potentially restored. If deleted Subscription is the last active subscription for Subscriber, Subscriber record is also deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSubscription","name":"Delete a Subscription","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes Subscription record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Records are soft-deleted which means that such deleted record can still be viewed and potentially restored."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If deleted Subscription is the last active subscription for Subscriber, Subscriber record is also deleted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"subscription_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscription to be deleted"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hubs/{subdomain}/subscriptions/{subscription_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/subscriptions/{subscription_id}","href":"subscription/deletesubscription","openApiOperationId":"deleteSubscription","summary":"Delete a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Success"]}},"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Success"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscription ID"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscription ID"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Success"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscription ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscription ID"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/deletesubscription"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscriptions/{subscription_id}"},{"label":"Restore a Subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscription/restoresubscription","routeSlug":"/api-v3-openapi/subscription/restoresubscription","metadata":{"seo":{"title":"Restore a Subscription","description":"Restores deleted Subscription.May fail if restoring would result in recordthat is not valid for example because subscription with that address alreadyexists.Restoring depending on data may either:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"restoreSubscription","name":"Restore a Subscription","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restore a Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restores deleted Subscription."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May fail if restoring would result in record"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that is not valid for example because subscription with that address already"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exists."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restoring depending on data may either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recreate the record as a new one with new ID,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Undelete the record preserving it ID."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"subscription_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscription to be deleted"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/subscriptions/{subscription_id}/restore","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/subscriptions/{subscription_id}/restore","href":"subscription/restoresubscription","openApiOperationId":"restoreSubscription","summary":"Restore a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Not allowed"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Not allowed"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscription ID"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscription ID"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Not allowed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Not allowed"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscription ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscription ID"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription/restoresubscription"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscriptions/{subscription_id}/restore"}],"content":{"contentType":"group","meta":{"name":"Subscription"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Individual subscription. It's a unique combination of:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription method,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events created on a Hub Page depending on configuration will be sent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to subscriptions of that Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription can be created for only a subset of Hub services which"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will result in not receiving notifications about events affecting"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"services that were not selected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to create or manage multiple subscriptions that should be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"associated with the same person or entity, it's recommended to use"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriber and Subscriber Subscription endpoints."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/subscriptions","summary":"Create a Subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscription/createsubscription","deprecated":false},{"title":"/hubs/{subdomain}/subscriptions","summary":"List Subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription/listsubscriptions","deprecated":false},{"title":"/hubs/{subdomain}/subscriptions/{subscription_id}","summary":"Retrieve a Subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription/getsubscription","deprecated":false},{"title":"/hubs/{subdomain}/subscriptions/{subscription_id}","summary":"Update a Subscription","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscription/updatesubscription","deprecated":false},{"title":"/hubs/{subdomain}/subscriptions/{subscription_id}","summary":"Delete a Subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscription/deletesubscription","deprecated":false},{"title":"/hubs/{subdomain}/subscriptions/{subscription_id}/restore","summary":"Restore a Subscription","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscription/restoresubscription","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscriber","link":"/api-v3-openapi/subscriber","routeSlug":"/api-v3-openapi/subscriber","items":[{"label":"Create a Subscriber","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscriber/createsubscriber","routeSlug":"/api-v3-openapi/subscriber/createsubscriber","metadata":{"seo":{"title":"Create a Subscriber","description":"Creates a new Subscriber. Main purpose of Subscriber is to create a record to which later one or many subscriptions can be added. One Subscriber can have multiple methods of communication associated with it. It also allows to set SAML NameID that can be then used to recognize Subscriber after sign-in into protected Hub Page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubscriber","name":"Create a Subscriber","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscribers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Subscriber","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Subscriber."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Main purpose of Subscriber is to create a record to which later one or many subscriptions can be added. One Subscriber can have multiple methods of communication associated with it."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It also allows to set SAML NameID that can be then used to recognize Subscriber after sign-in into protected Hub Page."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/subscribers_CreatePayload"}},"schemaId":"components/schemas/subscribers_CreatePayload","pointer":"/paths/~1hubs~1{subdomain}~1subscribers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/subscribers","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/subscribers_CreatePayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/subscribers","href":"subscriber/createsubscriber","openApiOperationId":"createSubscriber","summary":"Create a Subscriber"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/subscribers_CreatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/subscribers_CreatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}},"schemaId":"schema_66"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Already subscribed","paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Duplicated method","paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Invalid address","paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Invalid service IDs"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Already subscribed","paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Duplicated method","paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Invalid address","paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Invalid service IDs"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_66","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Already subscribed","paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Duplicated method","paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Invalid address","paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Invalid service IDs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Already subscribed","paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Duplicated method","paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Invalid address","paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Invalid service IDs"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriber/createsubscriber"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscribers"},{"label":"List Subscribers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscriber/listsubscribers","routeSlug":"/api-v3-openapi/subscriber/listsubscribers","metadata":{"seo":{"title":"List Subscribers","description":"Filters and returns Subscribers for current Hub with basic info."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscribers","name":"List Subscribers","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscribers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Subscribers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Filters and returns Subscribers for current Hub with basic info.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"deleted","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters subscribers by deletion status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only subscribers that were deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only subscribers that were not deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return subscribers without filtering by deleted status."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note that this filter work on subscriber level and does not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"check subscriptions deletion status during filtering."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String that filters subscribers to those containing the search string in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idp_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"sort_prop","in":"query","schemaId":"schema_64","description":"Determines which property results should be sorted by."},{"name":"sort_dir","in":"query","schemaId":"schema_4","description":"Determines sorting direction."},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/subscribers","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"}],"query":[{"name":"deleted","in":"query","schemaId":"schema_2"},{"name":"q","in":"query","example":"internal-identifier-at-company.com","schemaId":"schema_67"},{"name":"sort_prop","in":"query","schemaId":"schema_64"},{"name":"sort_dir","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/subscribers","href":"subscriber/listsubscribers","openApiOperationId":"listSubscribers","summary":"List Subscribers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_68"}},"schemaId":"schema_68"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/422/content/application~1json/examples/Wrong parameter value"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/422/content/application~1json/examples/Wrong parameter value"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_68","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_68"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/422/content/application~1json/examples/Wrong parameter value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers/get/responses/422/content/application~1json/examples/Wrong parameter value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriber/listsubscribers"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscribers"},{"label":"Retrieve a Subscriber","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscriber/getsubscriber","routeSlug":"/api-v3-openapi/subscriber/getsubscriber","metadata":{"seo":{"title":"Retrieve a Subscriber","description":"Returns data about single Subscriber."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscriber","name":"Retrieve a Subscriber","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Subscriber","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about single Subscriber."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"subscriber_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscriber"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/subscribers/{subscriber_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/subscribers/{subscriber_id}","href":"subscriber/getsubscriber","openApiOperationId":"getSubscriber","summary":"Retrieve a Subscriber"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}},"schemaId":"schema_66"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/404/content/application~1json/examples/Invalid Subscriber ID"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/404/content/application~1json/examples/Invalid Subscriber ID"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_66","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/404/content/application~1json/examples/Invalid Subscriber ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/404/content/application~1json/examples/Invalid Subscriber ID"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriber/getsubscriber"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscribers/{subscriber_id}"},{"label":"Updates a Subscriber","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscriber/updatesubscriber","routeSlug":"/api-v3-openapi/subscriber/updatesubscriber","metadata":{"seo":{"title":"Updates a Subscriber","description":"Modifies existing Subscriber. Only modified attributes may be passed in payload. All other attributes will remain unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSubscriber","name":"Updates a Subscriber","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a Subscriber","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modifies existing Subscriber."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only modified attributes may be passed in payload. All other attributes will remain unchanged."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"subscriber_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscriber"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePayload"}},"schemaId":"components/schemas/UpdatePayload","pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/subscribers/{subscriber_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/subscribers/{subscriber_id}","href":"subscriber/updatesubscriber","openApiOperationId":"updateSubscriber","summary":"Updates a Subscriber"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/UpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}},"schemaId":"schema_66"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/404/content/application~1json/examples/Invalid subscriber_id"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/404/content/application~1json/examples/Invalid subscriber_id"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/422/content/application~1json/examples/Duplicated IDP ID"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/422/content/application~1json/examples/Duplicated IDP ID"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_66","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/404/content/application~1json/examples/Invalid subscriber_id"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/404/content/application~1json/examples/Invalid subscriber_id"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/422/content/application~1json/examples/Duplicated IDP ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/422/content/application~1json/examples/Duplicated IDP ID"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriber/updatesubscriber"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscribers/{subscriber_id}"},{"label":"Delete a Subscriber","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscriber/deletesubscriber","routeSlug":"/api-v3-openapi/subscriber/deletesubscriber","metadata":{"seo":{"title":"Delete a Subscriber","description":"Deletes Subscriber record. Records are soft-deleted which means that such deleted record can still be viewed. Deleting Subscriber also deletes all its Subscriptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSubscriber","name":"Delete a Subscriber","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Subscriber","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes Subscriber record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Records are soft-deleted which means that such deleted record can still be viewed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deleting Subscriber also deletes all its Subscriptions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"subscriber_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscriber"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hubs/{subdomain}/subscribers/{subscriber_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/subscribers/{subscriber_id}","href":"subscriber/deletesubscriber","openApiOperationId":"deleteSubscriber","summary":"Delete a Subscriber"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/200/content/application~1json/examples/Success"]}},"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/200/content/application~1json/examples/Success"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/200/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/200/content/application~1json/examples/Success"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriber/deletesubscriber"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscribers/{subscriber_id}"}],"content":{"contentType":"group","meta":{"name":"Subscriber"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriber","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriber represents a consumer of StatusHub notifications that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can have multiple subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Those endpoints are typically used in one of two situations:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User is interested in subscriptions only for specific person or entity"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead of seeing or managing subscriptions for the whole Hub,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAML Hub protection method is being used. This results in subscriber"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"record containing SAML NameID value in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idp_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/subscribers","summary":"Create a Subscriber","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriber/createsubscriber","deprecated":false},{"title":"/hubs/{subdomain}/subscribers","summary":"List Subscribers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriber/listsubscribers","deprecated":false},{"title":"/hubs/{subdomain}/subscribers/{subscriber_id}","summary":"Retrieve a Subscriber","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriber/getsubscriber","deprecated":false},{"title":"/hubs/{subdomain}/subscribers/{subscriber_id}","summary":"Updates a Subscriber","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriber/updatesubscriber","deprecated":false},{"title":"/hubs/{subdomain}/subscribers/{subscriber_id}","summary":"Delete a Subscriber","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscriber/deletesubscriber","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscriber Subscription","link":"/api-v3-openapi/subscriber-subscription","routeSlug":"/api-v3-openapi/subscriber-subscription","items":[{"label":"Create a Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscriber-subscription/createsubscribersubscription","routeSlug":"/api-v3-openapi/subscriber-subscription/createsubscribersubscription","metadata":{"seo":{"title":"Create a Subscription","description":"Creates a new Subscription for existing Subscriber.Besides regular validation - like address correctness - there area few additional constraints:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubscriberSubscription","name":"Create a Subscription","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Subscription for existing Subscriber."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Besides regular validation - like address correctness - there are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a few additional constraints:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address has to be unique for current Hub,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Single Subscriber can't have multiple subscriptions with same method name."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example it's not allowed for one Subscriber to have for example"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two email subscriptions."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"subscriber_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscriber"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection"]}},"schemaId":"components/schemas/CreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection"],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions","href":"subscriber-subscription/createsubscribersubscription","openApiOperationId":"createSubscriberSubscription","summary":"Create a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/CreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePayload","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/404/content/application~1json/examples/Invalid subdomain"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/404/content/application~1json/examples/Invalid subdomain"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated address","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated method","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid address","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid Subscriber ID"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated address","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated method","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid address","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid Subscriber ID"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/404/content/application~1json/examples/Invalid subdomain"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/404/content/application~1json/examples/Invalid subdomain"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated address","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated method","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid address","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid Subscriber ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated address","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated method","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid address","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid Subscriber ID"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriber-subscription/createsubscribersubscription"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions"},{"label":"List Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscriber-subscription/listsubscribersubscriptions","routeSlug":"/api-v3-openapi/subscriber-subscription/listsubscribersubscriptions","metadata":{"seo":{"title":"List Subscriptions","description":"Filters and returns Subscriptions with basic info for existing Subscriber."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscriberSubscriptions","name":"List Subscriptions","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Filters and returns Subscriptions with basic info for existing Subscriber.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"subscriber_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscriber"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"deleted","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters subscriptions by deletion status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only subscriptions that were deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return only subscriptions that were not deleted,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - return subscriptions without filtering by deleted status."},"children":[]}]}]}]}]},{"name":"deleted_after","in":"query","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters Subscriptions by the timestamp of record deletion."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looks for Subscriptions deleted on or after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deleted_after"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO8601 formatted time (UTC)."},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"String that filters subscriptions to those containing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the search string in:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"extend","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which properties should be expanded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Expanded properties contains more detailed information which is less frequently needed in typical usage."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Currently supported only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"sort_prop","in":"query","schemaId":"schema_64","description":"Determines which property results should be sorted by."},{"name":"sort_dir","in":"query","schemaId":"schema_4","description":"Determines sorting direction."},{"name":"page","in":"query","schemaId":"schema_8","description":"Requested page index."},{"name":"per_page","in":"query","schemaId":"schema_9","description":"A limit on the number of records to be returned."},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"deleted","in":"query","schemaId":"schema_2"},{"name":"deleted_after","in":"query","example":"2020-09-01T08:29:00Z","schemaId":"schema_63"},{"name":"q","in":"query","schemaId":"components/schemas/components-Name"},{"name":"extend","in":"query","example":"flags","schemaId":"schema_7"},{"name":"sort_prop","in":"query","schemaId":"schema_64"},{"name":"sort_dir","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","schemaId":"schema_8"},{"name":"per_page","in":"query","schemaId":"schema_9"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions","href":"subscriber-subscription/listsubscribersubscriptions","openApiOperationId":"listSubscriberSubscriptions","summary":"List Subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}},"schemaId":"schema_65"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid Subscriber ID"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid Subscriber ID"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/422/content/application~1json/examples/Invalid extend param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/422/content/application~1json/examples/Invalid extend param"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_65","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid Subscriber ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid Subscriber ID"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/422/content/application~1json/examples/Invalid extend param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/422/content/application~1json/examples/Invalid extend param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriber-subscription/listsubscribersubscriptions"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions"},{"label":"Retrieve a Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscriber-subscription/getsubscribersubscription","routeSlug":"/api-v3-openapi/subscriber-subscription/getsubscribersubscription","metadata":{"seo":{"title":"Retrieve a Subscription","description":"Returns data about single Subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscriberSubscription","name":"Retrieve a Subscription","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns data about single Subscription."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"subscriber_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscriber"},"children":[]}]}]}],"required":true},{"name":"subscription_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscription to be deleted"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"extend","in":"query","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies which properties should be expanded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Expanded properties contains more detailed information which is less frequently needed in typical usage."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Currently supported only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_11"},{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"extend","in":"query","example":"flags","schemaId":"schema_7"},{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}","href":"subscriber-subscription/getsubscribersubscription","openApiOperationId":"getSubscriberSubscription","summary":"Retrieve a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscription ID"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscription ID"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscription ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscription ID"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Invalid extend param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Wrong parameter value","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Invalid extend param"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriber-subscription/getsubscribersubscription"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}"},{"label":"Update a Subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscriber-subscription/updatesubscribersubscription","routeSlug":"/api-v3-openapi/subscriber-subscription/updatesubscribersubscription","metadata":{"seo":{"title":"Update a Subscription","description":"Modifies existing Subscription. Only modified attributes may be passed in payload. All other attributes will remain unchanged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSubscriberSubscription","name":"Update a Subscription","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modifies existing Subscription."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only modified attributes may be passed in payload. All other attributes will remain unchanged."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"subscriber_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscriber"},"children":[]}]}]}],"required":true},{"name":"subscription_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscription to be deleted"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/subscriptions_UpdatePayload"}},"schemaId":"components/schemas/subscriptions_UpdatePayload","pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_11"},{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/subscriptions_UpdatePayload"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}","href":"subscriber-subscription/updatesubscribersubscription","openApiOperationId":"updateSubscriberSubscription","summary":"Update a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"schemaId":"components/schemas/subscriptions_UpdatePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/subscriptions_UpdatePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscription ID"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscription ID"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/422/content/application~1json/examples/Missing services selection"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/422/content/application~1json/examples/Missing services selection"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed JSON"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed JSON"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscription ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscription ID"]}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/422/content/application~1json/examples/Missing services selection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/422/content/application~1json/examples/Missing services selection"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriber-subscription/updatesubscribersubscription"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}"},{"label":"Delete a Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscriber-subscription/deletesubscribersubscription","routeSlug":"/api-v3-openapi/subscriber-subscription/deletesubscribersubscription","metadata":{"seo":{"title":"Delete a Subscription","description":"Deletes Subscription record. Records are soft-deleted which means that such deleted record can still be viewed and potentially restored. If deleted Subscription is the last active subscription for Subscriber, Subscriber record is also deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSubscriberSubscription","name":"Delete a Subscription","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes Subscription record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Records are soft-deleted which means that such deleted record can still be viewed and potentially restored."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If deleted Subscription is the last active subscription for Subscriber, Subscriber record is also deleted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"subscriber_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscriber"},"children":[]}]}]}],"required":true},{"name":"subscription_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscription to be deleted"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion","description":"Api version"}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_11"},{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"api_version","in":"query","schemaId":"components/schemas/ApiVersion"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}","href":"subscriber-subscription/deletesubscribersubscription","openApiOperationId":"deleteSubscriberSubscription","summary":"Delete a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Success"]}},"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Success"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscription ID"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscription ID"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Success"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscription ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscription ID"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriber-subscription/deletesubscribersubscription"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}"},{"label":"Restore a Subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-v3-openapi/subscriber-subscription/restoresubscribersubscription","routeSlug":"/api-v3-openapi/subscriber-subscription/restoresubscribersubscription","metadata":{"seo":{"title":"Restore a Subscription","description":"Restores deleted Subscription.May fail if restoring would result in recordthat is not valid, for example because subscription with that addressalready exists.Restoring depending on data may either:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"restoreSubscriberSubscription","name":"Restore a Subscription","isWebhook":false,"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restore a Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restores deleted Subscription."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May fail if restoring would result in record"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that is not valid, for example because subscription with that address"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"already exists."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restoring depending on data may either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recreate the record as a new one with new ID,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Undelete the record preserving it ID."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subdomain","in":"path","schemaId":"components/schemas/components-Name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of requested Hub."},"children":[]}]}]}],"required":true},{"name":"subscriber_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscriber"},"children":[]}]}]}],"required":true},{"name":"subscription_id","in":"path","schemaId":"schema_11","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the subscription to be deleted"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}/restore","servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"parameters":{"path":[{"name":"subdomain","in":"path","required":true,"schemaId":"components/schemas/components-Name"},{"name":"subscriber_id","in":"path","required":true,"schemaId":"schema_11"},{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}/restore","href":"subscriber-subscription/restoresubscribersubscription","openApiOperationId":"restoreSubscriberSubscription","summary":"Restore a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/401/content/application~1json/examples/Invalid API key"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/401/content/application~1json/examples/Invalid API key"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Not allowed"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Not allowed"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscription ID"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscription ID"]}],"pointer":"/paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/401/content/application~1json/examples/Invalid API key"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/401/content/application~1json/examples/Invalid API key"]}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Not allowed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Insufficient API key role","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Not allowed"]}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscription ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid subdomain","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscriber ID","paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscription ID"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriber-subscription/restoresubscribersubscription"}],"panels":[]}]},"httpPath":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}/restore"}],"content":{"contentType":"group","meta":{"name":"Subscriber Subscription"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriber Subscription","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Equivalent of Subscription endpoints but with scope limited to single"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriber record which "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided in request path."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions","summary":"Create a Subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriber-subscription/createsubscribersubscription","deprecated":false},{"title":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions","summary":"List Subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriber-subscription/listsubscribersubscriptions","deprecated":false},{"title":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}","summary":"Retrieve a Subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriber-subscription/getsubscribersubscription","deprecated":false},{"title":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}","summary":"Update a Subscription","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriber-subscription/updatesubscribersubscription","deprecated":false},{"title":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}","summary":"Delete a Subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscriber-subscription/deletesubscribersubscription","deprecated":false},{"title":"/hubs/{subdomain}/subscribers/{subscriber_id}/subscriptions/{subscription_id}/restore","summary":"Restore a Subscription","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriber-subscription/restoresubscribersubscription","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ApiVersion":{"id":"components/schemas/ApiVersion","kind":"json-schema","title":"ApiVersion","data":{"type":"string","enum":["V3-R1"]}},"components/schemas/PaginationData":{"id":"components/schemas/PaginationData","kind":"json-schema","title":"PaginationData","data":{"type":"object","required":["current_page","page_count","per_page","total"],"properties":{"current_page":{"type":"integer","minimum":1,"example":1},"page_count":{"type":"integer","minimum":1,"example":4},"per_page":{"type":"integer","minimum":1,"maximum":100,"example":25},"total":{"type":"integer","minimum":0,"example":1024}}}},"components/schemas/Id":{"id":"components/schemas/Id","kind":"json-schema","title":"Id","data":{"type":"integer","minimum":1,"x-autoid":true}},"components/schemas/Name":{"id":"components/schemas/Name","kind":"json-schema","title":"Name","data":{"type":"string","description":"Name of the Hub.","example":"Example Hub"}},"components/schemas/Subdomain":{"id":"components/schemas/Subdomain","kind":"json-schema","title":"Subdomain","data":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain serves two purposes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In various places it is being used as Hub unique identifier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in place of less descriptive numerical ID,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forms Hub URL which without custom domain in place has a form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{{subdomain}}.statushub.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"company-status"}},"components/schemas/HubType":{"id":"components/schemas/HubType","kind":"json-schema","title":"HubType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Independent Hub without any overlap with other Hubs data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated with billing subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can have Connected Hubs if its subscription allows it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connected Hub - Hub that shares following aspects with its Primary Hub:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Groups,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events affecting the shared Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other data like Subscriptions and settings is independent."},"children":[]}]}]}]}]}],"example":"primary","enum":["primary","connected"]}},"components/schemas/HubOverview":{"id":"components/schemas/HubOverview","kind":"json-schema","title":"HubOverview","data":{"type":"object","additionalProperties":false,"required":["id","name","subdomain","type"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":1},"name":{"type":"string","description":"Name of the Hub.","example":"Example Hub"},"subdomain":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain serves two purposes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In various places it is being used as Hub unique identifier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in place of less descriptive numerical ID,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forms Hub URL which without custom domain in place has a form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{{subdomain}}.statushub.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"company-status"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Independent Hub without any overlap with other Hubs data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated with billing subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can have Connected Hubs if its subscription allows it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connected Hub - Hub that shares following aspects with its Primary Hub:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Groups,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events affecting the shared Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other data like Subscriptions and settings is independent."},"children":[]}]}]}]}]}],"example":"primary","enum":["primary","connected"]}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object"}},"components/schemas/CustomDomain":{"id":"components/schemas/CustomDomain","kind":"json-schema","title":"CustomDomain","data":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative domain name under which the Hub can be accessed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently this field can be set only through a support ticket because of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the additional steps required like setting up the TLS certificate."},"children":[]}]}]}],"example":"status.example-company.com"}},"components/schemas/ParentID":{"id":"components/schemas/ParentID","kind":"json-schema","title":"ParentID","data":{"nullable":true,"type":"integer","minimum":1,"maximum":9999,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only for Connected Hubs. For Primary Hubs this field is absent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the numerical ID of Primary Hub for current Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}},"components/schemas/ProductURL":{"id":"components/schemas/ProductURL","kind":"json-schema","title":"ProductURL","data":{"type":"string","nullable":true,"description":"URL of the product or service for which current Hub is set-up for.\nAlternatively called \"Monitored site URL\" in Hub Main Settings in\nStatusHub Control Panel.\n\nUsed as a link target for Hub name or Logo in Hub Page top-bar.\n","example":"https://www.example-company.com/service"}},"components/schemas/CreatedAt":{"id":"components/schemas/CreatedAt","kind":"json-schema","title":"CreatedAt","data":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}},"components/schemas/UpdatedAt":{"id":"components/schemas/UpdatedAt","kind":"json-schema","title":"UpdatedAt","data":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}},"components/schemas/HubDetails":{"id":"components/schemas/HubDetails","kind":"json-schema","title":"HubDetails","data":{"type":"object","additionalProperties":false,"required":["id","name","subdomain","type","custom_domain","product_url","created_at","updated_at"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":3},"name":{"type":"string"},"subdomain":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain serves two purposes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In various places it is being used as Hub unique identifier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in place of less descriptive numerical ID,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forms Hub URL which without custom domain in place has a form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{{subdomain}}.statushub.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"company-status"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Independent Hub without any overlap with other Hubs data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated with billing subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can have Connected Hubs if its subscription allows it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connected Hub - Hub that shares following aspects with its Primary Hub:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Groups,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events affecting the shared Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other data like Subscriptions and settings is independent."},"children":[]}]}]}]}]}],"example":"primary","enum":["primary","connected"]},"custom_domain":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative domain name under which the Hub can be accessed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently this field can be set only through a support ticket because of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the additional steps required like setting up the TLS certificate."},"children":[]}]}]}],"example":"status.example-company.com"},"parent_id":{"nullable":true,"type":"integer","minimum":1,"maximum":9999,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only for Connected Hubs. For Primary Hubs this field is absent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the numerical ID of Primary Hub for current Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},"product_url":{"type":"string","nullable":true,"description":"URL of the product or service for which current Hub is set-up for.\nAlternatively called \"Monitored site URL\" in Hub Main Settings in\nStatusHub Control Panel.\n\nUsed as a link target for Hub name or Logo in Hub Page top-bar.\n","example":"https://www.example-company.com/service"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}}},"components/schemas/HubDetailsPayload":{"id":"components/schemas/HubDetailsPayload","kind":"json-schema","title":"HubDetailsPayload","data":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"product_url":{"type":"string","nullable":true,"description":"URL of the product or service for which current Hub is set-up for.\nAlternatively called \"Monitored site URL\" in Hub Main Settings in\nStatusHub Control Panel.\n\nUsed as a link target for Hub name or Logo in Hub Page top-bar.\n","example":"https://www.example-company.com/service"},"subdomain":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain serves two purposes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In various places it is being used as Hub unique identifier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in place of less descriptive numerical ID,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forms Hub URL which without custom domain in place has a form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{{subdomain}}.statushub.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"company-status"}}}},"components/schemas/StatusCounters":{"id":"components/schemas/StatusCounters","kind":"json-schema","title":"StatusCounters","data":{"type":"object","additionalProperties":false,"minProperties":1,"maxProperties":3,"properties":{"up":{"type":"integer","example":0},"degraded-performance":{"type":"integer","example":4},"down":{"type":"integer","example":1}}}},"components/schemas/CustomID":{"id":"components/schemas/CustomID","kind":"json-schema","title":"CustomID","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a property that can be used to assign an external identifier to a service. This identifier can be used, for example, to synchronize monitored entities with services in StatusHub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has to be unique within the scope of a Hub."},"children":[]}]}]}],"nullable":true}},"components/schemas/components-Name":{"id":"components/schemas/components-Name","kind":"json-schema","title":"components-Name","data":{"type":"string"}},"components/schemas/ServiceStatusName":{"id":"components/schemas/ServiceStatusName","kind":"json-schema","title":"ServiceStatusName","data":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"}},"components/schemas/Details":{"id":"components/schemas/Details","kind":"json-schema","title":"Details","data":{"type":"object","additionalProperties":false,"required":["service_id","custom_id","group_id","service_name","service_status","maintenance_ids","incident_ids"],"properties":{"service_id":{"type":"integer","minimum":1,"x-autoid":true,"example":4},"custom_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a property that can be used to assign an external identifier to a service. This identifier can be used, for example, to synchronize monitored entities with services in StatusHub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has to be unique within the scope of a Hub."},"children":[]}]}]}],"nullable":true},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":5},"service_name":{"type":"string"},"service_status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"},"maintenance_ids":{"type":"array","items":{"type":"integer","minimum":1,"x-autoid":true,"example":6}},"incident_ids":{"type":"array","items":{"type":"integer","minimum":1,"x-autoid":true,"example":7}}}}},"components/schemas/components-ParentID":{"id":"components/schemas/components-ParentID","kind":"json-schema","title":"components-ParentID","data":{"type":"integer","minimum":1,"maximum":9999,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the numerical ID of Primary Hub for current Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}},"components/schemas/Overview":{"id":"components/schemas/Overview","kind":"json-schema","title":"Overview","data":{"type":"object","additionalProperties":false,"required":["id","name","subdomain","parent_id"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":8},"name":{"type":"string","description":"Name of the Hub.","example":"Example Hub"},"subdomain":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain serves two purposes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In various places it is being used as Hub unique identifier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in place of less descriptive numerical ID,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forms Hub URL which without custom domain in place has a form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{{subdomain}}.statushub.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"company-status"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Independent Hub without any overlap with other Hubs data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated with billing subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can have Connected Hubs if its subscription allows it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connected Hub - Hub that shares following aspects with its Primary Hub:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Groups,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events affecting the shared Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other data like Subscriptions and settings is independent."},"children":[]}]}]}]}]}],"example":"primary","enum":["primary","connected"]},"parent_id":{"type":"integer","minimum":1,"maximum":9999,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the numerical ID of Primary Hub for current Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}}}},"components/schemas/Payload":{"id":"components/schemas/Payload","kind":"json-schema","title":"Payload","data":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"subdomain":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain serves two purposes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In various places it is being used as Hub unique identifier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in place of less descriptive numerical ID,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forms Hub URL which without custom domain in place has a form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{{subdomain}}.statushub.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"company-status"},"product_url":{"type":"string","nullable":true,"description":"URL of the product or service for which current Hub is set-up for.\nAlternatively called \"Monitored site URL\" in Hub Main Settings in\nStatusHub Control Panel.\n\nUsed as a link target for Hub name or Logo in Hub Page top-bar.\n","example":"https://www.example-company.com/service"}}}},"components/schemas/connected_hubs_Details":{"id":"components/schemas/connected_hubs_Details","kind":"json-schema","title":"connected_hubs_Details","data":{"type":"object","additionalProperties":false,"required":["id","name","subdomain","custom_domain","parent_id","product_url","created_at","updated_at"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":12},"name":{"type":"string"},"subdomain":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain serves two purposes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In various places it is being used as Hub unique identifier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in place of less descriptive numerical ID,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forms Hub URL which without custom domain in place has a form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{{subdomain}}.statushub.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"company-status"},"custom_domain":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative domain name under which the Hub can be accessed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently this field can be set only through a support ticket because of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the additional steps required like setting up the TLS certificate."},"children":[]}]}]}],"example":"status.example-company.com"},"parent_id":{"nullable":true,"type":"integer","minimum":1,"maximum":9999,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only for Connected Hubs. For Primary Hubs this field is absent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the numerical ID of Primary Hub for current Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},"product_url":{"type":"string","nullable":true,"description":"URL of the product or service for which current Hub is set-up for.\nAlternatively called \"Monitored site URL\" in Hub Main Settings in\nStatusHub Control Panel.\n\nUsed as a link target for Hub name or Logo in Hub Page top-bar.\n","example":"https://www.example-company.com/service"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Independent Hub without any overlap with other Hubs data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated with billing subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can have Connected Hubs if its subscription allows it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connected Hub - Hub that shares following aspects with its Primary Hub:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Groups,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events affecting the shared Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other data like Subscriptions and settings is independent."},"children":[]}]}]}]}]}],"example":"primary","enum":["primary","connected"]},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}}},"components/schemas/OKResponse":{"id":"components/schemas/OKResponse","kind":"json-schema","title":"OKResponse","data":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}}},"components/schemas/RestrictionUserMethodName":{"id":"components/schemas/RestrictionUserMethodName","kind":"json-schema","title":"RestrictionUserMethodName","data":{"type":"string","enum":["saml","google_oauth","global_password","public"]}},"components/schemas/MethodsOverview":{"id":"components/schemas/MethodsOverview","kind":"json-schema","title":"MethodsOverview","data":{"type":"object","additionalProperties":false,"required":["allowed_methods","enabled_method"],"properties":{"allowed_methods":{"type":"array","items":{"type":"string","enum":["saml","google_oauth","global_password","public"]},"example":["saml","google_oauth","global_password","public"]},"enabled_method":{"type":"string","enum":["saml","google_oauth","global_password","public"]}}}},"components/schemas/IdPMetadata":{"id":"components/schemas/IdPMetadata","kind":"json-schema","title":"IdPMetadata","data":{"type":"string","nullable":true,"description":"IdP SAML metadata in XML format.\n","example":"<?xml version=\"1.0\"?>\n<md:EntityDescriptor\n  xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\"\n  entityID=\"https://some-idp.company.com/\"\n>\n...\n</md:EntityDescriptor>\n"}},"components/schemas/Debug":{"id":"components/schemas/Debug","kind":"json-schema","title":"Debug","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls verbosity of SAML error page:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Show detailed error message,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Show generic error message without details."},"children":[]}]}]}]}]}},"components/schemas/SignOutTarget":{"id":"components/schemas/SignOutTarget","kind":"json-schema","title":"SignOutTarget","data":{"type":"string","format":"uri","nullable":true,"description":"Location where user will be redirected after successful sign-out.\n"}},"components/schemas/SLO":{"id":"components/schemas/SLO","kind":"json-schema","title":"SLO","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls if SLO should be used when signing-out from Hub:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - SLO is enabled. This requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SingleLogoutService"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration to be included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idp_metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - SLO is not enabled."},"children":[]}]}]}]}]}},"components/schemas/URL":{"id":"components/schemas/URL","kind":"json-schema","title":"URL","data":{"type":"string","format":"uri"}},"components/schemas/URI":{"id":"components/schemas/URI","kind":"json-schema","title":"URI","data":{"type":"string","format":"uri"}},"components/schemas/SPData":{"id":"components/schemas/SPData","kind":"json-schema","title":"SPData","data":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informational field."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns identifiers and URL that can be used to setup SAML connection."},"children":[]}]}]}],"required":["certificate_url","metadata_url","entity_id","sso_url","slo_url"],"properties":{"certificate_url":{"description":"URL from which StatusHub SAML public certificate can be downloaded\nfrom.\n","type":"string","format":"uri"},"metadata_url":{"description":"URL from which StatusHub SP metadata in XML format can be downloaded\nfrom.\n","type":"string","format":"uri"},"entity_id":{"description":"SP Entity ID.","type":"string","format":"uri"},"sso_url":{"description":"Sign-on URL.","type":"string","format":"uri"},"slo_url":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sign-out URL. Works only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled."},"children":[]}]}]}],"type":"string","format":"uri"}}}},"components/schemas/SAMLDetails":{"id":"components/schemas/SAMLDetails","kind":"json-schema","title":"SAMLDetails","data":{"type":"object","additionalProperties":false,"required":["enabled","idp_metadata","slo","sp_data","debug","sign_out_target"],"properties":{"enabled":{"type":"boolean"},"idp_metadata":{"type":"string","nullable":true,"description":"IdP SAML metadata in XML format.\n","example":"<?xml version=\"1.0\"?>\n<md:EntityDescriptor\n  xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\"\n  entityID=\"https://some-idp.company.com/\"\n>\n...\n</md:EntityDescriptor>\n"},"debug":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls verbosity of SAML error page:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Show detailed error message,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Show generic error message without details."},"children":[]}]}]}]}]},"sign_out_target":{"type":"string","format":"uri","nullable":true,"description":"Location where user will be redirected after successful sign-out.\n"},"slo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls if SLO should be used when signing-out from Hub:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - SLO is enabled. This requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SingleLogoutService"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration to be included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idp_metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - SLO is not enabled."},"children":[]}]}]}]}]},"sp_data":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informational field."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns identifiers and URL that can be used to setup SAML connection."},"children":[]}]}]}],"required":[],"properties":{"certificate_url":{"description":"URL from which StatusHub SAML public certificate can be downloaded\nfrom.\n","type":"string","format":"uri"},"metadata_url":{"description":"URL from which StatusHub SP metadata in XML format can be downloaded\nfrom.\n","type":"string","format":"uri"},"entity_id":{"description":"SP Entity ID.","type":"string","format":"uri"},"sso_url":{"description":"Sign-on URL.","type":"string","format":"uri"},"slo_url":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sign-out URL. Works only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled."},"children":[]}]}]}],"type":"string","format":"uri"}}}}}},"components/schemas/SAMLPayload":{"id":"components/schemas/SAMLPayload","kind":"json-schema","title":"SAMLPayload","data":{"type":"object","additionalProperties":false,"properties":{"enabled":{"type":"boolean"},"idp_metadata":{"type":"string","nullable":true,"description":"IdP SAML metadata in XML format.\n","example":"<?xml version=\"1.0\"?>\n<md:EntityDescriptor\n  xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\"\n  entityID=\"https://some-idp.company.com/\"\n>\n...\n</md:EntityDescriptor>\n"},"slo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls if SLO should be used when signing-out from Hub:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - SLO is enabled. This requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SingleLogoutService"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration to be included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idp_metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - SLO is not enabled."},"children":[]}]}]}]}]},"debug":{"nullable":true,"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls verbosity of SAML error page:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Show detailed error message,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Show generic error message without details."},"children":[]}]}]}]}]},"sign_out_target":{"nullable":true,"type":"string","format":"uri","description":"Location where user will be redirected after successful sign-out.\n"}}}},"components/schemas/Enabled":{"id":"components/schemas/Enabled","kind":"json-schema","title":"Enabled","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Google OAuth authorization."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In order to enable this method the domains whitelist has to be set and enabled."},"children":[]}]}]}]}},"components/schemas/GoogleOAuthDetails":{"id":"components/schemas/GoogleOAuthDetails","kind":"json-schema","title":"GoogleOAuthDetails","data":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Google OAuth authorization."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In order to enable this method the domains whitelist has to be set and enabled."},"children":[]}]}]}]}}}},"components/schemas/GoogleOAuthPayload":{"id":"components/schemas/GoogleOAuthPayload","kind":"json-schema","title":"GoogleOAuthPayload","data":{"type":"object","additionalProperties":false,"properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Google OAuth authorization."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In order to enable this method the domains whitelist has to be set and enabled."},"children":[]}]}]}]}}}},"components/schemas/GlobalPasswordDetails":{"id":"components/schemas/GlobalPasswordDetails","kind":"json-schema","title":"GlobalPasswordDetails","data":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"type":"boolean"}}}},"components/schemas/GlobalPasswordPayload":{"id":"components/schemas/GlobalPasswordPayload","kind":"json-schema","title":"GlobalPasswordPayload","data":{"type":"object","additionalProperties":false,"properties":{"enabled":{"type":"boolean"},"password":{"type":"string","minLength":8,"maxLength":255}}}},"components/schemas/DomainName":{"id":"components/schemas/DomainName","kind":"json-schema","title":"DomainName","data":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]\\.[a-z]{2,}"}},"components/schemas/DomainsWhitelist":{"id":"components/schemas/DomainsWhitelist","kind":"json-schema","title":"DomainsWhitelist","data":{"type":"array","items":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]\\.[a-z]{2,}"},"description":"Array of domain names.\n","example":["company.com","another-domain.com"]}},"components/schemas/DomainsWhitelistDetails":{"id":"components/schemas/DomainsWhitelistDetails","kind":"json-schema","title":"DomainsWhitelistDetails","data":{"type":"object","additionalProperties":false,"required":["enabled","domains_whitelist"],"properties":{"enabled":{"type":"boolean"},"domains_whitelist":{"type":"array","items":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]\\.[a-z]{2,}"},"description":"Array of domain names.\n","example":["company.com","another-domain.com"]}}}},"components/schemas/DomainsWhitelistPayload":{"id":"components/schemas/DomainsWhitelistPayload","kind":"json-schema","title":"DomainsWhitelistPayload","data":{"type":"object","additionalProperties":false,"properties":{"enabled":{"type":"boolean"},"domains_whitelist":{"type":"array","items":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]\\.[a-z]{2,}"},"description":"Array of domain names.\n","example":["company.com","another-domain.com"]}}}},"components/schemas/IPV4":{"id":"components/schemas/IPV4","kind":"json-schema","title":"IPV4","data":{"type":"string","pattern":"([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}","description":"IP V4 address"}},"components/schemas/IPV4CIDR":{"id":"components/schemas/IPV4CIDR","kind":"json-schema","title":"IPV4CIDR","data":{"type":"string","pattern":"([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\/[0-9]{1,2}","description":"IP V4 range in CIDR format\n"}},"components/schemas/IPs":{"id":"components/schemas/IPs","kind":"json-schema","title":"IPs","data":{"type":"array","items":{"anyOf":[{"type":"string","pattern":"([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}","description":"IP V4 address"},{"type":"string","pattern":"([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\/[0-9]{1,2}","description":"IP V4 range in CIDR format\n"}]},"example":["54.210.121.161","144.201.96.0/21"]}},"components/schemas/NetworkDetails":{"id":"components/schemas/NetworkDetails","kind":"json-schema","title":"NetworkDetails","data":{"type":"object","additionalProperties":false,"required":["enabled","ip_whitelist"],"properties":{"enabled":{"type":"boolean"},"ip_whitelist":{"type":"array","items":{"anyOf":[{"type":"string","pattern":"([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}","description":"IP V4 address"},{"type":"string","pattern":"([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\/[0-9]{1,2}","description":"IP V4 range in CIDR format\n"}]},"example":["54.210.121.161","144.201.96.0/21"]}}}},"components/schemas/NetworkPayload":{"id":"components/schemas/NetworkPayload","kind":"json-schema","title":"NetworkPayload","data":{"type":"object","additionalProperties":false,"properties":{"enabled":{"type":"boolean"},"ip_whitelist":{"type":"array","items":{"anyOf":[{"type":"string","pattern":"([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}","description":"IP V4 address"},{"type":"string","pattern":"([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\/[0-9]{1,2}","description":"IP V4 range in CIDR format\n"}]},"example":["54.210.121.161","144.201.96.0/21"]}}}},"components/schemas/Description":{"id":"components/schemas/Description","kind":"json-schema","title":"Description","data":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional description than can be visible on Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" May contain basic HTML tags."},"children":[]}]}]}]}},"components/schemas/URLNullable":{"id":"components/schemas/URLNullable","kind":"json-schema","title":"URLNullable","data":{"type":"string","format":"uri","nullable":true}},"components/schemas/NavbarItem":{"id":"components/schemas/NavbarItem","kind":"json-schema","title":"NavbarItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows to add button with link to Hub Page navbar."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Both label and URL are mandatory if any of those fields contains value."},"children":[]}]}]}],"additionalProperties":false,"properties":{"label":{"type":"string","nullable":true,"example":"Support portal"},"url":{"example":"https://help.example-company.com","type":"string","format":"uri","nullable":true}}}},"components/schemas/StatusNames":{"id":"components/schemas/StatusNames","kind":"json-schema","title":"StatusNames","data":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom labels used on Hub Page legend section."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can be used to change default values to better match Hub Page use-case."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For example if Hub Page is set to show availability of meeting rooms then 'down' may mean 'Room is not available' and 'degraded-performance' may mean 'Room is booked'."},"children":[]}]}]}],"properties":{"up":{"type":"string","default":"Service is operating normally"},"degraded-performance":{"type":"string","default":"Performance issues"},"down":{"type":"string","default":"Service disruption"}}}},"components/schemas/ISOWeek":{"id":"components/schemas/ISOWeek","kind":"json-schema","title":"ISOWeek","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use ISO week numbering system:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true - week starts on Monday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false - week starts on Sunday."},"children":[]}]}]}]}]}},"components/schemas/DateFormat":{"id":"components/schemas/DateFormat","kind":"json-schema","title":"DateFormat","data":{"type":"string","enum":["EU","US"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used date format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EU - dd/mm/yyyy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US - mm/dd/yyyy"},"children":[]}]}]}]}]}},"components/schemas/TimeFormat":{"id":"components/schemas/TimeFormat","kind":"json-schema","title":"TimeFormat","data":{"type":"string","enum":["12h","24h"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used time format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12h - hh:mm AM/PM,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"24h - HH:mm."},"children":[]}]}]}]}]}},"components/schemas/TimeZoneName":{"id":"components/schemas/TimeZoneName","kind":"json-schema","title":"TimeZoneName","data":{"type":"string","description":"Default time zone used for Hub Page for visitors who haven't chosen different time zone.\n"}},"components/schemas/ViewType":{"id":"components/schemas/ViewType","kind":"json-schema","title":"ViewType","data":{"type":"string","enum":["list","calendar","no_history","connected_hubs_grid"],"description":"History view type\n"}},"components/schemas/BackgroundColor":{"id":"components/schemas/BackgroundColor","kind":"json-schema","title":"BackgroundColor","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom background color in Hex format."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For Hubs still using background image, setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"background_color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will remove the background image which can then only be added through a support request."},"children":[]}]}]}],"example":"#ffffff"}},"components/schemas/PlatformAlerts":{"id":"components/schemas/PlatformAlerts","kind":"json-schema","title":"PlatformAlerts","data":{"type":"boolean","description":"Show platform alerts on this Hub Page"}},"components/schemas/HubsSwitcher":{"id":"components/schemas/HubsSwitcher","kind":"json-schema","title":"HubsSwitcher","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show Hubs switcher on this Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This setting controls if the Hub Switcher is visible on current Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In order to choose which Hubs are visible in Hub Switcher "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"show_in_hubs_switcher"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be used on respective Hubs."},"children":[]}]}]}]}},"components/schemas/ShowInHubsSwitcher":{"id":"components/schemas/ShowInHubsSwitcher","kind":"json-schema","title":"ShowInHubsSwitcher","data":{"type":"boolean","description":"Show this Hub inside Hubs Switcher in Hubs that show the Hubs Switcher in current account.\n"}},"components/schemas/UptimeChart":{"id":"components/schemas/UptimeChart","kind":"json-schema","title":"UptimeChart","data":{"type":"boolean","description":"Shows uptime chart on hits Hub Page."}},"components/schemas/Whitelabel":{"id":"components/schemas/Whitelabel","kind":"json-schema","title":"Whitelabel","data":{"type":"boolean","description":"Hide default \"Powered by StatusHub\" footer.\n"}},"components/schemas/BackgroundImageURL":{"id":"components/schemas/BackgroundImageURL","kind":"json-schema","title":"BackgroundImageURL","data":{"type":"string","format":"uri","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of image used as Hub background image."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This is a read-only field and is a legacy feature."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"background_color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set, it's not possible to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"background_image"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"background_image_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" again in API nor in StatusHub Control Panel. Only way to set the background image is through a support request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is not returned when background image is not being used."},"children":[]}]}]}]}},"components/schemas/AppearanceDetails":{"id":"components/schemas/AppearanceDetails","kind":"json-schema","title":"AppearanceDetails","data":{"type":"object","additionalProperties":false,"required":["description","favicon_url","logo_url","navbar_item","status_names","localization","layout"],"properties":{"description":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional description than can be visible on Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" May contain basic HTML tags."},"children":[]}]}]}]},"favicon_url":{"description":"URL of Hub favicon image.","type":"string","format":"uri","nullable":true},"logo_url":{"description":"URL of Hub logo image.","type":"string","format":"uri","nullable":true},"navbar_item":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows to add button with link to Hub Page navbar."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Both label and URL are mandatory if any of those fields contains value."},"children":[]}]}]}],"additionalProperties":false,"properties":{"label":{"type":"string","nullable":true,"example":"Support portal"},"url":{"example":"https://help.example-company.com","type":"string","format":"uri","nullable":true}}},"status_names":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom labels used on Hub Page legend section."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can be used to change default values to better match Hub Page use-case."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For example if Hub Page is set to show availability of meeting rooms then 'down' may mean 'Room is not available' and 'degraded-performance' may mean 'Room is booked'."},"children":[]}]}]}],"properties":{"up":{"type":"string","default":"Service is operating normally"},"degraded-performance":{"type":"string","default":"Performance issues"},"down":{"type":"string","default":"Service disruption"}}},"localization":{"type":"object","additionalProperties":false,"required":[],"properties":{"iso_week":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use ISO week numbering system:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true - week starts on Monday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false - week starts on Sunday."},"children":[]}]}]}]}]},"date_format":{"type":"string","enum":["EU","US"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used date format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EU - dd/mm/yyyy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US - mm/dd/yyyy"},"children":[]}]}]}]}]},"time_format":{"type":"string","enum":["12h","24h"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used time format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12h - hh:mm AM/PM,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"24h - HH:mm."},"children":[]}]}]}]}]},"time_zone_name":{"type":"string","description":"Default time zone used for Hub Page for visitors who haven't chosen different time zone.\n"}}},"layout":{"type":"object","additionalProperties":false,"required":[],"properties":{"view_type":{"type":"string","enum":["list","calendar","no_history","connected_hubs_grid"],"description":"History view type\n"},"background_color":{"nullable":true,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom background color in Hex format."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For Hubs still using background image, setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"background_color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will remove the background image which can then only be added through a support request."},"children":[]}]}]}],"example":"#ffffff"},"platform_alerts":{"type":"boolean","description":"Show platform alerts on this Hub Page"},"hubs_switcher":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show Hubs switcher on this Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This setting controls if the Hub Switcher is visible on current Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In order to choose which Hubs are visible in Hub Switcher "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"show_in_hubs_switcher"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be used on respective Hubs."},"children":[]}]}]}]},"show_in_hubs_switcher":{"type":"boolean","description":"Show this Hub inside Hubs Switcher in Hubs that show the Hubs Switcher in current account.\n"},"uptime_chart":{"type":"boolean","description":"Shows uptime chart on hits Hub Page."},"whitelabel":{"type":"boolean","description":"Hide default \"Powered by StatusHub\" footer.\n"},"background_image_url":{"type":"string","format":"uri","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of image used as Hub background image."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This is a read-only field and is a legacy feature."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"background_color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set, it's not possible to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"background_image"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"background_image_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" again in API nor in StatusHub Control Panel. Only way to set the background image is through a support request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is not returned when background image is not being used."},"children":[]}]}]}]}}}}}},"components/schemas/AppearancePayload":{"id":"components/schemas/AppearancePayload","kind":"json-schema","title":"AppearancePayload","data":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional description than can be visible on Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" May contain basic HTML tags."},"children":[]}]}]}]},"navbar_item":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows to add button with link to Hub Page navbar."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Both label and URL are mandatory if any of those fields contains value."},"children":[]}]}]}],"additionalProperties":false,"properties":{"label":{"type":"string","nullable":true,"example":"Support portal"},"url":{"example":"https://help.example-company.com","type":"string","format":"uri","nullable":true}}},"status_names":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom labels used on Hub Page legend section."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can be used to change default values to better match Hub Page use-case."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For example if Hub Page is set to show availability of meeting rooms then 'down' may mean 'Room is not available' and 'degraded-performance' may mean 'Room is booked'."},"children":[]}]}]}],"properties":{"up":{"type":"string","default":"Service is operating normally"},"degraded-performance":{"type":"string","default":"Performance issues"},"down":{"type":"string","default":"Service disruption"}}},"localization":{"type":"object","additionalProperties":false,"properties":{"iso_week":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use ISO week numbering system:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true - week starts on Monday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false - week starts on Sunday."},"children":[]}]}]}]}]},"date_format":{"type":"string","enum":["EU","US"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used date format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EU - dd/mm/yyyy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US - mm/dd/yyyy"},"children":[]}]}]}]}]},"time_format":{"type":"string","enum":["12h","24h"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used time format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12h - hh:mm AM/PM,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"24h - HH:mm."},"children":[]}]}]}]}]},"time_zone_name":{"type":"string","description":"Default time zone used for Hub Page for visitors who haven't chosen different time zone.\n"}}},"layout":{"type":"object","additionalProperties":false,"properties":{"view_type":{"type":"string","enum":["list","calendar","no_history","connected_hubs_grid"],"description":"History view type\n"},"background_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom background color in Hex format."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For Hubs still using background image, setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"background_color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will remove the background image which can then only be added through a support request."},"children":[]}]}]}],"example":"#ffffff"},"platform_alerts":{"type":"boolean","description":"Show platform alerts on this Hub Page"},"hubs_switcher":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show Hubs switcher on this Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This setting controls if the Hub Switcher is visible on current Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In order to choose which Hubs are visible in Hub Switcher "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"show_in_hubs_switcher"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be used on respective Hubs."},"children":[]}]}]}]},"show_in_hubs_switcher":{"type":"boolean","description":"Show this Hub inside Hubs Switcher in Hubs that show the Hubs Switcher in current account.\n"},"uptime_chart":{"type":"boolean","description":"Shows uptime chart on hits Hub Page."},"whitelabel":{"type":"boolean","description":"Hide default \"Powered by StatusHub\" footer.\n"}}}}}},"components/schemas/AssetPayload":{"id":"components/schemas/AssetPayload","kind":"json-schema","title":"AssetPayload","data":{"type":"object","additionalProperties":false,"required":["type","file"],"properties":{"type":{"type":"string","enum":["logo","favicon"],"description":"Type of asset to create"},"file":{"type":"string","format":"binary","description":"File to upload as asset"}}}},"components/schemas/AssetDetails":{"id":"components/schemas/AssetDetails","kind":"json-schema","title":"AssetDetails","data":{"type":"object","properties":{"url":{"type":"string","format":"uri"}}}},"components/schemas/Title":{"id":"components/schemas/Title","kind":"json-schema","title":"Title","data":{"type":"string"}},"components/schemas/Body":{"id":"components/schemas/Body","kind":"json-schema","title":"Body","data":{"type":"string"}},"components/schemas/SilentUpdate":{"id":"components/schemas/SilentUpdate","kind":"json-schema","title":"SilentUpdate","data":{"type":"boolean","description":"Send notification to subscribers"}},"components/schemas/PlatformAlert":{"id":"components/schemas/PlatformAlert","kind":"json-schema","title":"PlatformAlert","data":{"type":"object","additionalProperties":false,"required":["active","title","body","silent"],"properties":{"active":{"type":"boolean"},"title":{"type":"string"},"body":{"type":"string"},"silent":{"type":"boolean","description":"Send notification to subscribers"}}}},"components/schemas/BadRequestResponse":{"id":"components/schemas/BadRequestResponse","kind":"json-schema","title":"BadRequestResponse","data":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}}},"components/schemas/IncidentTitle":{"id":"components/schemas/IncidentTitle","kind":"json-schema","title":"IncidentTitle","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of incident as visible on Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If there is draft IncidentUpdate that changes the title, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not reflect this change because the draft update is not published and therefore not visible on Hub Page."},"children":[]}]}]}]}},"components/schemas/IncidentType":{"id":"components/schemas/IncidentType","kind":"json-schema","title":"IncidentType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Exact meaning may depend on use case and there is just one restriction:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can't be used as type of a first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]}]}]}],"enum":["investigating","identified","monitoring","resolved"],"example":"investigating"}},"components/schemas/IncidentStartTime":{"id":"components/schemas/IncidentStartTime","kind":"json-schema","title":"IncidentStartTime","data":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}},"components/schemas/EventEndTime":{"id":"components/schemas/EventEndTime","kind":"json-schema","title":"EventEndTime","data":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event end. If not set it means that the event has not ended yet."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}},"components/schemas/DraftIncident":{"id":"components/schemas/DraftIncident","kind":"json-schema","title":"DraftIncident","data":{"type":"boolean","description":"Does this incident has any unpublished updates (drafts)."}},"components/schemas/IncidentBasicFlags":{"id":"components/schemas/IncidentBasicFlags","kind":"json-schema","title":"Basic flags","data":{"type":"object","title":"Basic flags","additionalProperties":false,"required":["deleted","draft"],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Does this incident has any unpublished updates (drafts)."}}}},"components/schemas/UnconfirmedIncident":{"id":"components/schemas/UnconfirmedIncident","kind":"json-schema","title":"UnconfirmedIncident","data":{"type":"boolean","description":"Is it an unconfirmed incident. Unconfirmed incidents are still visible on Hub Page.\n"}},"components/schemas/IncidentExtendedFlags":{"id":"components/schemas/IncidentExtendedFlags","kind":"json-schema","title":"Extended flags","data":{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":["archived","deleted","draft","follow_up","published","unconfirmed"],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services has been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Does this incident has any unpublished updates (drafts)."},"follow_up":{"type":"boolean","description":"Is it a follow-up incident."},"published":{"type":"boolean","description":"Event was published on Hub Page."},"unconfirmed":{"type":"boolean","description":"Is it an unconfirmed incident. Unconfirmed incidents are still visible on Hub Page.\n"}}}},"components/schemas/IncidentOverview":{"id":"components/schemas/IncidentOverview","kind":"json-schema","title":"IncidentOverview","data":{"type":"object","additionalProperties":false,"required":["id","title","last_incident_type","start_time","end_time","flags"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":13},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of incident as visible on Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If there is draft IncidentUpdate that changes the title, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not reflect this change because the draft update is not published and therefore not visible on Hub Page."},"children":[]}]}]}]},"last_incident_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Exact meaning may depend on use case and there is just one restriction:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can't be used as type of a first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]}]}]}],"enum":["investigating","identified","monitoring","resolved"],"example":"investigating"},"start_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"end_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event end. If not set it means that the event has not ended yet."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Does this incident has any unpublished updates (drafts)."}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services has been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Does this incident has any unpublished updates (drafts)."},"follow_up":{"type":"boolean","description":"Is it a follow-up incident."},"published":{"type":"boolean","description":"Event was published on Hub Page."},"unconfirmed":{"type":"boolean","description":"Is it an unconfirmed incident. Unconfirmed incidents are still visible on Hub Page.\n"}}}]}}}},"components/schemas/EventTitle":{"id":"components/schemas/EventTitle","kind":"json-schema","title":"EventTitle","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text. HTML tags and other forms of formatting are not allowed."},"children":[]}]}]}],"example":"Title of the event"}},"components/schemas/EventStartTimeParam":{"id":"components/schemas/EventStartTimeParam","kind":"json-schema","title":"EventStartTimeParam","data":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event start."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can't be in future."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}},"components/schemas/ServiceStatusesPayload":{"id":"components/schemas/ServiceStatusesPayload","kind":"json-schema","title":"ServiceStatusesPayload","data":{"type":"array","description":"Describes affected services and their statuses.\n","items":{"type":"object","additionalProperties":false,"properties":{"service_id":{"type":"integer","example":1234},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"}}}}},"components/schemas/common_Body":{"id":"components/schemas/common_Body","kind":"json-schema","title":"common_Body","data":{"type":"string","default":"","example":"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"}},"components/schemas/common_SilentUpdate":{"id":"components/schemas/common_SilentUpdate","kind":"json-schema","title":"common_SilentUpdate","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notifications are not being sent to subscribers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}],"default":false}},"components/schemas/IncidentState":{"id":"components/schemas/IncidentState","kind":"json-schema","title":"IncidentState","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Incident or Incident Update:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Not published on Hub Page,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unconfirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page but marked as unconfirmed,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page."},"children":[]}]}]}]}],"default":"published","example":"published","nullable":true,"enum":["draft","unconfirmed","published"]}},"components/schemas/OriginalIncidentID":{"id":"components/schemas/OriginalIncidentID","kind":"json-schema","title":"OriginalIncidentID","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used when creating a follow-up incident. Indicated the incident to which current incident is a follow-up."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Original Incident ID has to be resolved."},"children":[]}]}]}],"minimum":1,"example":102}},"components/schemas/IncidentPayload":{"id":"components/schemas/IncidentPayload","kind":"json-schema","title":"IncidentPayload","data":{"type":"object","additionalProperties":false,"required":["title","start_time","incident_type","service_statuses"],"properties":{"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text. HTML tags and other forms of formatting are not allowed."},"children":[]}]}]}],"example":"Title of the event"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event start."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can't be in future."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"incident_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Exact meaning may depend on use case and there is just one restriction:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can't be used as type of a first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]}]}]}],"enum":["investigating","identified","monitoring","resolved"],"example":"investigating"},"service_statuses":{"type":"array","description":"Describes affected services and their statuses.\n","items":{"type":"object","additionalProperties":false,"properties":{"service_id":{"type":"integer","example":1234},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"}}}},"body":{"type":"string","default":"","example":"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notifications are not being sent to subscribers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}],"default":false},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Incident or Incident Update:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Not published on Hub Page,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unconfirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page but marked as unconfirmed,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page."},"children":[]}]}]}]}],"default":"published","example":"published","nullable":true,"enum":["draft","unconfirmed","published"]},"original_incident_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used when creating a follow-up incident. Indicated the incident to which current incident is a follow-up."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Original Incident ID has to be resolved."},"children":[]}]}]}],"minimum":1,"example":102}}}},"components/schemas/Author":{"id":"components/schemas/Author","kind":"json-schema","title":"Author","data":{"type":"string","nullable":true,"description":"Author email"}},"components/schemas/IncidentDetails":{"id":"components/schemas/IncidentDetails","kind":"json-schema","title":"IncidentDetails","data":{"type":"object","additionalProperties":false,"required":["id","author","title","created_at","start_time","updated_at","end_time","flags"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":15},"author":{"type":"string","nullable":true,"description":"Author email"},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of incident as visible on Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If there is draft IncidentUpdate that changes the title, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not reflect this change because the draft update is not published and therefore not visible on Hub Page."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"start_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"end_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event end. If not set it means that the event has not ended yet."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Does this incident has any unpublished updates (drafts)."}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services has been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Does this incident has any unpublished updates (drafts)."},"follow_up":{"type":"boolean","description":"Is it a follow-up incident."},"published":{"type":"boolean","description":"Event was published on Hub Page."},"unconfirmed":{"type":"boolean","description":"Is it an unconfirmed incident. Unconfirmed incidents are still visible on Hub Page.\n"}}}]}}}},"components/schemas/IncidentUpdateTitle":{"id":"components/schemas/IncidentUpdateTitle","kind":"json-schema","title":"IncidentUpdateTitle","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of this update. May be different from current incident title."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Incident title may be changed during the duration of incident and therefore some updates may reflect previous title."},"children":[]}]}]}]}},"components/schemas/IncidentUpdateStartTime":{"id":"components/schemas/IncidentUpdateStartTime","kind":"json-schema","title":"IncidentUpdateStartTime","data":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamps of a Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}},"components/schemas/EventState":{"id":"components/schemas/EventState","kind":"json-schema","title":"EventState","data":{"type":"string","enum":["undefined","draft","unconfirmed","published"],"description":"Event state","example":"published"}},"components/schemas/IncidentUpdateBasicFlags":{"id":"components/schemas/IncidentUpdateBasicFlags","kind":"json-schema","title":"Basic flags","data":{"type":"object","title":"Basic flags","additionalProperties":false,"required":["deleted","draft"],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Incident Update a draft - meaning it wasn't published on a Hub Page.\n"}}}},"components/schemas/IncidentUpdateExtendedFlags":{"id":"components/schemas/IncidentUpdateExtendedFlags","kind":"json-schema","title":"Extended flags","data":{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":["archived","deleted","draft","silent","unconfirmed"],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services has been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Incident Update a draft - meaning it wasn't published on a Hub Page.\n"},"unconfirmed":{"type":"boolean","description":"Is it an unconfirmed Incident Update. Unconfirmed can only be a first Incident Update of an Incident. Unconfirmed Incident Updates are still visible on Hub Page.\n"},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is it a silent Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Silent event does not result in notifications being sent to subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}]}}}},"components/schemas/IncidentUpdateOverview":{"id":"components/schemas/IncidentUpdateOverview","kind":"json-schema","title":"IncidentUpdateOverview","data":{"type":"object","additionalProperties":false,"required":["id","title","incident_type","state"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":16},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of this update. May be different from current incident title."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Incident title may be changed during the duration of incident and therefore some updates may reflect previous title."},"children":[]}]}]}]},"incident_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Exact meaning may depend on use case and there is just one restriction:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can't be used as type of a first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]}]}]}],"enum":["investigating","identified","monitoring","resolved"],"example":"investigating"},"start_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamps of a Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"state":{"type":"string","enum":["undefined","draft","unconfirmed","published"],"description":"Event state","example":"published"},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Incident Update a draft - meaning it wasn't published on a Hub Page.\n"}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services has been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Incident Update a draft - meaning it wasn't published on a Hub Page.\n"},"unconfirmed":{"type":"boolean","description":"Is it an unconfirmed Incident Update. Unconfirmed can only be a first Incident Update of an Incident. Unconfirmed Incident Updates are still visible on Hub Page.\n"},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is it a silent Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Silent event does not result in notifications being sent to subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}]}}}]}}}},"components/schemas/IncidentUpdateTitleParam":{"id":"components/schemas/IncidentUpdateTitleParam","kind":"json-schema","title":"IncidentUpdateTitleParam","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of this update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to value different from current title of Incident may result in changing of Incident title."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Incident title equals to title of latest (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") published (not draft) Incident Update "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/ServiceStatusesCreatePayload":{"id":"components/schemas/ServiceStatusesCreatePayload","kind":"json-schema","title":"ServiceStatusesCreatePayload","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes affected services and their statuses."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This parameter is required unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incident_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in which case it is forbidden because resolving an incident automatically sets all affected services to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"up"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status for this incident."},"children":[]}]}]}],"items":{"type":"object","additionalProperties":false,"properties":{"service_id":{"type":"integer","example":1234},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"}}}}},"components/schemas/IncidentUpdateCreatePayload":{"id":"components/schemas/IncidentUpdateCreatePayload","kind":"json-schema","title":"IncidentUpdateCreatePayload","data":{"type":"object","additionalProperties":false,"required":["title","start_time","incident_type"],"properties":{"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of this update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to value different from current title of Incident may result in changing of Incident title."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Incident title equals to title of latest (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") published (not draft) Incident Update "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"start_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event start."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can't be in future."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"incident_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Exact meaning may depend on use case and there is just one restriction:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can't be used as type of a first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]}]}]}],"enum":["investigating","identified","monitoring","resolved"],"example":"investigating"},"service_statuses":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes affected services and their statuses."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This parameter is required unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incident_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in which case it is forbidden because resolving an incident automatically sets all affected services to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"up"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status for this incident."},"children":[]}]}]}],"items":{"type":"object","additionalProperties":false,"properties":{"service_id":{"type":"integer","example":1234},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"}}}},"body":{"type":"string","default":"","example":"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notifications are not being sent to subscribers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}],"default":false},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Incident or Incident Update:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Not published on Hub Page,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unconfirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page but marked as unconfirmed,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page."},"children":[]}]}]}]}],"default":"published","example":"published","nullable":true,"enum":["draft","unconfirmed","published"]}}}},"components/schemas/ServiceStatuses":{"id":"components/schemas/ServiceStatuses","kind":"json-schema","title":"ServiceStatuses","data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":61},"service_id":{"type":"integer","minimum":1,"x-autoid":true,"example":62},"service_name":{"type":"string"},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":63},"group_name":{"type":"string"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean"},"archived":{"type":"boolean"}}}}}}},"components/schemas/IncidentUpdateDetails":{"id":"components/schemas/IncidentUpdateDetails","kind":"json-schema","title":"IncidentUpdateDetails","data":{"type":"object","additionalProperties":false,"required":["id","author","body","title","created_at","start_time","updated_at","incident_type","service_statuses","state"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":25},"author":{"type":"string","nullable":true,"description":"Author email"},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of this update. May be different from current incident title."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Incident title may be changed during the duration of incident and therefore some updates may reflect previous title."},"children":[]}]}]}]},"body":{"type":"string","default":"","example":"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"start_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamps of a Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"incident_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Exact meaning may depend on use case and there is just one restriction:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can't be used as type of a first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]}]}]}],"enum":["investigating","identified","monitoring","resolved"],"example":"investigating"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Incident or Incident Update:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Not published on Hub Page,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unconfirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page but marked as unconfirmed,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page."},"children":[]}]}]}]}],"default":"published","example":"published","nullable":true,"enum":["draft","unconfirmed","published"]},"service_statuses":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":61},"service_id":{"type":"integer","minimum":1,"x-autoid":true,"example":62},"service_name":{"type":"string"},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":63},"group_name":{"type":"string"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean"},"archived":{"type":"boolean"}}}}}},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Incident Update a draft - meaning it wasn't published on a Hub Page.\n"}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services has been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Incident Update a draft - meaning it wasn't published on a Hub Page.\n"},"unconfirmed":{"type":"boolean","description":"Is it an unconfirmed Incident Update. Unconfirmed can only be a first Incident Update of an Incident. Unconfirmed Incident Updates are still visible on Hub Page.\n"},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is it a silent Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Silent event does not result in notifications being sent to subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}]}}}]}}}},"components/schemas/ServiceStatusesUpdatePayload":{"id":"components/schemas/ServiceStatusesUpdatePayload","kind":"json-schema","title":"ServiceStatusesUpdatePayload","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes affected services and their statuses."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This parameter is forbidden if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incident_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" because resolving an incident automatically sets all affected services to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"up"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status for this incident."},"children":[]}]}]}],"items":{"type":"object","additionalProperties":false,"properties":{"service_id":{"type":"integer","example":1234},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"}}}}},"components/schemas/IncidentUpdateUpdatePayload":{"id":"components/schemas/IncidentUpdateUpdatePayload","kind":"json-schema","title":"IncidentUpdateUpdatePayload","data":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of this update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to value different from current title of Incident may result in changing of Incident title."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Incident title equals to title of latest (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") published (not draft) Incident Update "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"start_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event start."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can't be in future."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"incident_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Exact meaning may depend on use case and there is just one restriction:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can't be used as type of a first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]}]}]}],"enum":["investigating","identified","monitoring","resolved"],"example":"investigating"},"service_statuses":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes affected services and their statuses."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This parameter is forbidden if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incident_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" because resolving an incident automatically sets all affected services to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"up"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status for this incident."},"children":[]}]}]}],"items":{"type":"object","additionalProperties":false,"properties":{"service_id":{"type":"integer","example":1234},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"}}}},"body":{"type":"string","default":"","example":"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notifications are not being sent to subscribers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}],"default":false},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Incident or Incident Update:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Not published on Hub Page,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unconfirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page but marked as unconfirmed,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page."},"children":[]}]}]}]}],"default":"published","example":"published","nullable":true,"enum":["draft","unconfirmed","published"]}}}},"components/schemas/templates_Title":{"id":"components/schemas/templates_Title","kind":"json-schema","title":"templates_Title","data":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]}},"components/schemas/Label":{"id":"components/schemas/Label","kind":"json-schema","title":"Label","data":{"type":"string"}},"components/schemas/Labels":{"id":"components/schemas/Labels","kind":"json-schema","title":"Labels","data":{"type":"array","items":{"type":"string"},"description":"List of labels for this template."}},"components/schemas/Silent":{"id":"components/schemas/Silent","kind":"json-schema","title":"Silent","data":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value when applying the template:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Do not set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}]}},"components/schemas/Flags":{"id":"components/schemas/Flags","kind":"json-schema","title":"Flags","data":{"type":"object","additionalProperties":false,"required":["deleted","silent"],"properties":{"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this template deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deleted templates can't be used when creating or updating events."},"children":[]}]}]}]},"silent":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value when applying the template:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Do not set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}]}}}},"components/schemas/templates_IncidentType":{"id":"components/schemas/templates_IncidentType","kind":"json-schema","title":"templates_IncidentType","data":{"type":"string","nullable":true,"enum":["investigating","identified","monitoring","resolved"]}},"components/schemas/IncidentUpdateTemplateOverview":{"id":"components/schemas/IncidentUpdateTemplateOverview","kind":"json-schema","title":"IncidentUpdateTemplateOverview","data":{"type":"object","additionalProperties":false,"required":["id","title","labels","flags","incident_type"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":29},"title":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"labels":{"type":"array","items":{"type":"string"},"description":"List of labels for this template."},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this template deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deleted templates can't be used when creating or updating events."},"children":[]}]}]}]},"silent":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value when applying the template:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Do not set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}]}}},"incident_type":{"type":"string","nullable":true,"enum":["investigating","identified","monitoring","resolved"]}}}},"components/schemas/TitleParam":{"id":"components/schemas/TitleParam","kind":"json-schema","title":"TitleParam","data":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event. Can be omitted if body is provided."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text. HTML tags and other forms of formatting are not allowed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]}},"components/schemas/BodyParam":{"id":"components/schemas/BodyParam","kind":"json-schema","title":"BodyParam","data":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event. Can be omitted if title is provided."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain basic HTML tags and is being interpreted as HTML."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]}},"components/schemas/LabelsParam":{"id":"components/schemas/LabelsParam","kind":"json-schema","title":"LabelsParam","data":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of labels for this template. Template can have many labels."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If passing just one label, it should still be passed as an array: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"labels\": [\"some label value\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/IncidentUpdateTemplatePayload":{"id":"components/schemas/IncidentUpdateTemplatePayload","kind":"json-schema","title":"IncidentUpdateTemplatePayload","data":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event. Can be omitted if body is provided."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text. HTML tags and other forms of formatting are not allowed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"body":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event. Can be omitted if title is provided."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain basic HTML tags and is being interpreted as HTML."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"incident_type":{"type":"string","nullable":true,"enum":["investigating","identified","monitoring","resolved"]},"labels":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of labels for this template. Template can have many labels."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If passing just one label, it should still be passed as an array: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"labels\": [\"some label value\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"service_statuses":{"type":"array","description":"Describes affected services and their statuses.\n","items":{"type":"object","additionalProperties":false,"properties":{"service_id":{"type":"integer","example":1234},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"}}}},"silent_update":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value when applying the template:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Do not set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}]}}}},"components/schemas/templates_Body":{"id":"components/schemas/templates_Body","kind":"json-schema","title":"templates_Body","data":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]}},"components/schemas/IncidentUpdateTemplateDetails":{"id":"components/schemas/IncidentUpdateTemplateDetails","kind":"json-schema","title":"IncidentUpdateTemplateDetails","data":{"type":"object","additionalProperties":false,"required":["id","title","labels","flags","incident_type","body","created_at","updated_at","author","service_statuses"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":38},"title":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"labels":{"type":"array","items":{"type":"string"},"description":"List of labels for this template."},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this template deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deleted templates can't be used when creating or updating events."},"children":[]}]}]}]},"silent":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value when applying the template:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Do not set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}]}}},"incident_type":{"type":"string","nullable":true,"enum":["investigating","identified","monitoring","resolved"]},"body":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"author":{"type":"string","nullable":true,"description":"Author email"},"service_statuses":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":61},"service_id":{"type":"integer","minimum":1,"x-autoid":true,"example":62},"service_name":{"type":"string"},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":63},"group_name":{"type":"string"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean"},"archived":{"type":"boolean"}}}}}}}}},"components/schemas/StartTime":{"id":"components/schemas/StartTime","kind":"json-schema","title":"StartTime","data":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event start."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}},"components/schemas/EndTime":{"id":"components/schemas/EndTime","kind":"json-schema","title":"EndTime","data":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event end."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}},"components/schemas/MaintenanceBasicFlags":{"id":"components/schemas/MaintenanceBasicFlags","kind":"json-schema","title":"Basic flags","data":{"type":"object","title":"Basic flags","additionalProperties":false,"required":["deleted","draft"],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Maintenance a draft - meaning, it wasn't published on a Hub Page.\n"}}}},"components/schemas/SuppressEvents":{"id":"components/schemas/SuppressEvents","kind":"json-schema","title":"SuppressEvents","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the duration of maintenance all Incidents and Incident Updates created through automation (API, integrations) will not be published."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Depending on configuration such Incidents will be either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"saved as draft,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ignored."},"children":[]}]}]}]}]}},"components/schemas/MaintenanceExtendedFlags":{"id":"components/schemas/MaintenanceExtendedFlags","kind":"json-schema","title":"Extended flags","data":{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":["archived","deleted","draft","published","suppress_events","silent","recurring_placeholder"],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services have been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Maintenance a draft - meaning, it wasn't published on a Hub Page.\n"},"published":{"type":"boolean","description":"Was this Maintenance event published on a Hub Page.\n"},"suppress_events":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the duration of maintenance all Incidents and Incident Updates created through automation (API, integrations) will not be published."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Depending on configuration such Incidents will be either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"saved as draft,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ignored."},"children":[]}]}]}]}]},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is it a silent Maintenance."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Silent events do not result in notifications being sent to subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}]},"recurring_placeholder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring maintenance schedule utilize so called Placeholder Events that are visible on Hub Page and contains all of the info as normal Maintenance events would."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" However those placeholders are not fully fledged Maintenance events and some operations may not be available for those placeholder events. For example, such events when deleted are permanently removed and are not a subject to undelete."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Placeholder events are converted to normal (full) Maintenance events when either maintenance will start soon or notifications needs to be send for this event. After converting Placeholder Maintenance to normal Maintenance, such event behaves like any other normal Maintenance event."},"children":[]}]}]}]}}}},"components/schemas/MaintenanceOverview":{"id":"components/schemas/MaintenanceOverview","kind":"json-schema","title":"MaintenanceOverview","data":{"type":"object","additionalProperties":false,"required":["id","title","start_time","end_time","flags"],"properties":{"id":{"type":"string"},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text. HTML tags and other forms of formatting are not allowed."},"children":[]}]}]}],"example":"Title of the event"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event start."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"end_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event end."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Maintenance a draft - meaning, it wasn't published on a Hub Page.\n"}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services have been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Maintenance a draft - meaning, it wasn't published on a Hub Page.\n"},"published":{"type":"boolean","description":"Was this Maintenance event published on a Hub Page.\n"},"suppress_events":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the duration of maintenance all Incidents and Incident Updates created through automation (API, integrations) will not be published."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Depending on configuration such Incidents will be either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"saved as draft,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ignored."},"children":[]}]}]}]}]},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is it a silent Maintenance."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Silent events do not result in notifications being sent to subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}]},"recurring_placeholder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring maintenance schedule utilize so called Placeholder Events that are visible on Hub Page and contains all of the info as normal Maintenance events would."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" However those placeholders are not fully fledged Maintenance events and some operations may not be available for those placeholder events. For example, such events when deleted are permanently removed and are not a subject to undelete."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Placeholder events are converted to normal (full) Maintenance events when either maintenance will start soon or notifications needs to be send for this event. After converting Placeholder Maintenance to normal Maintenance, such event behaves like any other normal Maintenance event."},"children":[]}]}]}]}}}]}}}},"components/schemas/StateParam":{"id":"components/schemas/StateParam","kind":"json-schema","title":"StateParam","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Maintenance event:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Not published on Hub Page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draft will result in draft notifications being sent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to Team Members,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page."},"children":[]}]}]}]}],"default":"published","nullable":true,"enum":["draft","published"]}},"components/schemas/EventRepeat":{"id":"components/schemas/EventRepeat","kind":"json-schema","title":"EventRepeat","data":{"type":"object","nullable":true,"description":"Describes recurring maintenance schedules.\n","properties":{"interval":{"type":"string","description":"How frequent should the event be repeated.\n","enum":["day","week","two_weeks","month","year"]},"interval_options":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional configuration for some of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"enabled_days":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"interval\": \"day\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of enabled days indexes (0-6)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 - Sunday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 - Monday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 - Tuesday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 - Wednesday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 - Thursday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 - Friday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6 - Saturday."},"children":[]}]}]}]}],"example":"0,2,5"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"interval\": \"month\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Month interval type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Repeat on same day of month. For example on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every 5th of the month,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Repeat on the same occurrence of nth day of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"week. For example on 2nd Saturday of the month."},"children":[]}]}]}]}],"enum":["day_of_month","day_of_week"],"default":"day_of_month"}}},"end_on":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When should the repeating of recurring maintenance event stop."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If not set, recurring schedule will continue. ISO8601 formatted time (UTC)"},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}}},"components/schemas/EventNotificationsParam":{"id":"components/schemas/EventNotificationsParam","kind":"json-schema","title":"EventNotificationsParam","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes additional notifications to be sent at specific offset from maintenance start or end."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Those additional notifications can be used for sending automated reminder notification to subscriptions about upcoming or just finished maintenance."},"children":[]}]}]}],"items":{"type":"object","properties":{"offset_in_min":{"type":"integer","description":"Negative value of offset in minutes.\n","maximum":0,"example":-60,"enum":[-129600,-86400,-43200,-10080,-2880,-1440,-120,-60,-30,-15,-5,0]},"offset_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EventNotification delivery offset type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance start time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance end time."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not all combinations are possible for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset_in_min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-129600 - 90 days,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-86400 - 60 days,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-43200 - 30 days,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-10080 - 7 days,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-2880 - 2 days,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1440 - 1 days,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-120 - 2 hours,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-60 - 1 hour,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-30 - 30 minutes,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-15 - 15 minutes,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-5 - 5 minutes,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 - at event start ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 - at event end ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"default":"start","enum":["start","end"]}}}}},"components/schemas/MaintenancePayload":{"id":"components/schemas/MaintenancePayload","kind":"json-schema","title":"MaintenancePayload","data":{"type":"object","additionalProperties":false,"required":["title","start_time","end_time","service_statuses"],"properties":{"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text. HTML tags and other forms of formatting are not allowed."},"children":[]}]}]}],"example":"Title of the event"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event start."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"end_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event end."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"service_statuses":{"type":"array","description":"Describes affected services and their statuses.\n","items":{"type":"object","additionalProperties":false,"properties":{"service_id":{"type":"integer","example":1234},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"}}}},"body":{"type":"string","default":"","example":"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notifications are not being sent to subscribers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}],"default":false},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Maintenance event:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Not published on Hub Page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draft will result in draft notifications being sent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to Team Members,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page."},"children":[]}]}]}]}],"default":"published","nullable":true,"enum":["draft","published"]},"suppress_events":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the duration of maintenance all Incidents and Incident Updates created through automation (API, integrations) will not be published."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Depending on configuration such Incidents will be either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"saved as draft,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ignored."},"children":[]}]}]}]}]},"event_repeat":{"type":"object","nullable":true,"description":"Describes recurring maintenance schedules.\n","properties":{"interval":{"type":"string","description":"How frequent should the event be repeated.\n","enum":["day","week","two_weeks","month","year"]},"interval_options":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional configuration for some of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"enabled_days":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"interval\": \"day\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of enabled days indexes (0-6)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 - Sunday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 - Monday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 - Tuesday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 - Wednesday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 - Thursday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 - Friday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6 - Saturday."},"children":[]}]}]}]}],"example":"0,2,5"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"interval\": \"month\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Month interval type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Repeat on same day of month. For example on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every 5th of the month,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Repeat on the same occurrence of nth day of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"week. For example on 2nd Saturday of the month."},"children":[]}]}]}]}],"enum":["day_of_month","day_of_week"],"default":"day_of_month"}}},"end_on":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When should the repeating of recurring maintenance event stop."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If not set, recurring schedule will continue. ISO8601 formatted time (UTC)"},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}},"event_notifications":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes additional notifications to be sent at specific offset from maintenance start or end."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Those additional notifications can be used for sending automated reminder notification to subscriptions about upcoming or just finished maintenance."},"children":[]}]}]}],"items":{"type":"object","properties":{"offset_in_min":{"type":"integer","description":"Negative value of offset in minutes.\n","maximum":0,"example":-60,"enum":[-129600,-86400,-43200,-10080,-2880,-1440,-120,-60,-30,-15,-5,0]},"offset_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EventNotification delivery offset type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance start time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance end time."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not all combinations are possible for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset_in_min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-129600 - 90 days,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-86400 - 60 days,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-43200 - 30 days,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-10080 - 7 days,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-2880 - 2 days,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1440 - 1 days,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-120 - 2 hours,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-60 - 1 hour,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-30 - 30 minutes,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-15 - 15 minutes,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-5 - 5 minutes,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 - at event start ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 - at event end ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"default":"start","enum":["start","end"]}}}}}}},"components/schemas/EventNotifications":{"id":"components/schemas/EventNotifications","kind":"json-schema","title":"EventNotifications","data":{"type":"array","description":"Describes additional notifications to be sent at specific offset from maintenance start or end.\n","items":{"type":"object","properties":{"offset_in_min":{"type":"integer","description":"Negative value of offset in minutes.\n","maximum":0,"example":-60,"enum":[-129600,-86400,-43200,-10080,-2880,-1440,-120,-60,-30,-15,-5,0]},"offset_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EventNotification delivery offset type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance start time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance end time."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}],"default":"start","enum":["start","end"]}}}}},"components/schemas/MaintenanceDetails":{"id":"components/schemas/MaintenanceDetails","kind":"json-schema","title":"MaintenanceDetails","data":{"type":"object","additionalProperties":false,"required":["id","author","created_at","title","body","start_time","end_time","service_statuses","flags","updated_at"],"properties":{"id":{"type":"string"},"author":{"type":"string","nullable":true,"description":"Author email"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text. HTML tags and other forms of formatting are not allowed."},"children":[]}]}]}],"example":"Title of the event"},"body":{"type":"string","default":"","example":"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"},"event_repeat":{"type":"object","nullable":true,"description":"Describes recurring maintenance schedules.\n","properties":{"interval":{"type":"string","description":"How frequent should the event be repeated.\n","enum":["day","week","two_weeks","month","year"]},"interval_options":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional configuration for some of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"enabled_days":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"interval\": \"day\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of enabled days indexes (0-6)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 - Sunday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 - Monday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 - Tuesday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 - Wednesday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 - Thursday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 - Friday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6 - Saturday."},"children":[]}]}]}]}],"example":"0,2,5"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"interval\": \"month\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Month interval type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Repeat on same day of month. For example on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every 5th of the month,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Repeat on the same occurrence of nth day of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"week. For example on 2nd Saturday of the month."},"children":[]}]}]}]}],"enum":["day_of_month","day_of_week"],"default":"day_of_month"}}},"end_on":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When should the repeating of recurring maintenance event stop."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If not set, recurring schedule will continue. ISO8601 formatted time (UTC)"},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}},"event_notifications":{"type":"array","description":"Describes additional notifications to be sent at specific offset from maintenance start or end.\n","items":{"type":"object","properties":{"offset_in_min":{"type":"integer","description":"Negative value of offset in minutes.\n","maximum":0,"example":-60,"enum":[-129600,-86400,-43200,-10080,-2880,-1440,-120,-60,-30,-15,-5,0]},"offset_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EventNotification delivery offset type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance start time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance end time."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}],"default":"start","enum":["start","end"]}}}},"service_statuses":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":61},"service_id":{"type":"integer","minimum":1,"x-autoid":true,"example":62},"service_name":{"type":"string"},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":63},"group_name":{"type":"string"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean"},"archived":{"type":"boolean"}}}}}},"start_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event start."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"end_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event end."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Maintenance a draft - meaning, it wasn't published on a Hub Page.\n"}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services have been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Maintenance a draft - meaning, it wasn't published on a Hub Page.\n"},"published":{"type":"boolean","description":"Was this Maintenance event published on a Hub Page.\n"},"suppress_events":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the duration of maintenance all Incidents and Incident Updates created through automation (API, integrations) will not be published."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Depending on configuration such Incidents will be either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"saved as draft,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ignored."},"children":[]}]}]}]}]},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is it a silent Maintenance."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Silent events do not result in notifications being sent to subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}]},"recurring_placeholder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring maintenance schedule utilize so called Placeholder Events that are visible on Hub Page and contains all of the info as normal Maintenance events would."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" However those placeholders are not fully fledged Maintenance events and some operations may not be available for those placeholder events. For example, such events when deleted are permanently removed and are not a subject to undelete."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Placeholder events are converted to normal (full) Maintenance events when either maintenance will start soon or notifications needs to be send for this event. After converting Placeholder Maintenance to normal Maintenance, such event behaves like any other normal Maintenance event."},"children":[]}]}]}]}}}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}}},"components/schemas/UpdateMaintenancePayload":{"id":"components/schemas/UpdateMaintenancePayload","kind":"json-schema","title":"UpdateMaintenancePayload","data":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text. HTML tags and other forms of formatting are not allowed."},"children":[]}]}]}],"example":"Title of the event"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event start."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"end_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event end."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"service_statuses":{"type":"array","description":"Describes affected services and their statuses.\n","items":{"type":"object","additionalProperties":false,"properties":{"service_id":{"type":"integer","example":1234},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"}}}},"body":{"type":"string","default":"","example":"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notifications are not being sent to subscribers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}],"default":false},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Maintenance event:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Not published on Hub Page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draft will result in draft notifications being sent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to Team Members,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page."},"children":[]}]}]}]}],"default":"published","nullable":true,"enum":["draft","published"]},"suppress_events":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the duration of maintenance all Incidents and Incident Updates created through automation (API, integrations) will not be published."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Depending on configuration such Incidents will be either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"saved as draft,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ignored."},"children":[]}]}]}]}]},"event_repeat":{"type":"object","nullable":true,"description":"Describes recurring maintenance schedules.\n","properties":{"interval":{"type":"string","description":"How frequent should the event be repeated.\n","enum":["day","week","two_weeks","month","year"]},"interval_options":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional configuration for some of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"enabled_days":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"interval\": \"day\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of enabled days indexes (0-6)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 - Sunday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 - Monday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 - Tuesday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 - Wednesday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 - Thursday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 - Friday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6 - Saturday."},"children":[]}]}]}]}],"example":"0,2,5"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"interval\": \"month\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Month interval type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Repeat on same day of month. For example on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every 5th of the month,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Repeat on the same occurrence of nth day of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"week. For example on 2nd Saturday of the month."},"children":[]}]}]}]}],"enum":["day_of_month","day_of_week"],"default":"day_of_month"}}},"end_on":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When should the repeating of recurring maintenance event stop."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If not set, recurring schedule will continue. ISO8601 formatted time (UTC)"},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}},"event_notifications":{"type":"array","description":"Describes additional notifications to be sent at specific offset from maintenance start or end.\n","items":{"type":"object","properties":{"offset_in_min":{"type":"integer","description":"Negative value of offset in minutes.\n","maximum":0,"example":-60,"enum":[-129600,-86400,-43200,-10080,-2880,-1440,-120,-60,-30,-15,-5,0]},"offset_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EventNotification delivery offset type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance start time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance end time."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}],"default":"start","enum":["start","end"]}}}},"recurring":{"type":"object","description":"Used only for Maintenance events being a part of Recurring Maintenance Schedule. Instructs API how to handle edit of an event that is repeating.\n","additionalProperties":false,"properties":{"update_following":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" modifies currently updated event as well as all following events being a part of the same Recurring Maintenance Schedule."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" modifies only currently updated event. Following events in same Recurring Maintenance Schedule remains unchanged."},"children":[]}]}]}]}}}}}},"components/schemas/UpdateRecurringEventsPayload":{"id":"components/schemas/UpdateRecurringEventsPayload","kind":"json-schema","title":"UpdateRecurringEventsPayload","data":{"type":"object","additionalProperties":false,"properties":{"recurring":{"type":"object","required":["update_following"],"additionalProperties":false,"properties":{"update_following":{"type":"boolean"}}}}}},"components/schemas/Duration":{"id":"components/schemas/Duration","kind":"json-schema","title":"Duration","data":{"type":"integer","nullable":true,"minimum":1,"maximum":5999,"description":"Duration of maintenance in minutes.\n"}},"components/schemas/MaintenanceTemplateOverview":{"id":"components/schemas/MaintenanceTemplateOverview","kind":"json-schema","title":"MaintenanceTemplateOverview","data":{"type":"object","additionalProperties":false,"required":["id","title","labels","flags","duration"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":51},"title":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"labels":{"type":"array","items":{"type":"string"},"description":"List of labels for this template."},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this template deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deleted templates can't be used when creating or updating events."},"children":[]}]}]}]},"silent":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value when applying the template:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Do not set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}]}}},"duration":{"type":"integer","nullable":true,"minimum":1,"maximum":5999,"description":"Duration of maintenance in minutes.\n"}}}},"components/schemas/DurationParam":{"id":"components/schemas/DurationParam","kind":"json-schema","title":"DurationParam","data":{"type":"integer","nullable":true,"minimum":1,"maximum":5999,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of maintenance in minutes."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum allowed value is 99h:59min (5999 minutes)."},"children":[]}]}]}]}},"components/schemas/MaintenanceTemplatePayload":{"id":"components/schemas/MaintenanceTemplatePayload","kind":"json-schema","title":"MaintenanceTemplatePayload","data":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event. Can be omitted if body is provided."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text. HTML tags and other forms of formatting are not allowed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"body":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event. Can be omitted if title is provided."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain basic HTML tags and is being interpreted as HTML."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"duration":{"type":"integer","nullable":true,"minimum":1,"maximum":5999,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of maintenance in minutes."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum allowed value is 99h:59min (5999 minutes)."},"children":[]}]}]}]},"labels":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of labels for this template. Template can have many labels."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If passing just one label, it should still be passed as an array: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"labels\": [\"some label value\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"service_statuses":{"type":"array","description":"Describes affected services and their statuses.\n","items":{"type":"object","additionalProperties":false,"properties":{"service_id":{"type":"integer","example":1234},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"}}}},"silent":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value when applying the template:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Do not set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}]}}}},"components/schemas/MaintenanceTemplateDetails":{"id":"components/schemas/MaintenanceTemplateDetails","kind":"json-schema","title":"MaintenanceTemplateDetails","data":{"type":"object","additionalProperties":false,"required":["id","title","labels","flags","duration","body","created_at","updated_at","author","service_statuses"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":60},"title":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"labels":{"type":"array","items":{"type":"string"},"description":"List of labels for this template."},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this template deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deleted templates can't be used when creating or updating events."},"children":[]}]}]}]},"silent":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value when applying the template:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Do not set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}]}}},"duration":{"type":"integer","nullable":true,"minimum":1,"maximum":5999,"description":"Duration of maintenance in minutes.\n"},"body":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"author":{"type":"string","nullable":true,"description":"Author email"},"service_statuses":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":61},"service_id":{"type":"integer","minimum":1,"x-autoid":true,"example":62},"service_name":{"type":"string"},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":63},"group_name":{"type":"string"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean"},"archived":{"type":"boolean"}}}}}}}}},"components/schemas/IDPID":{"id":"components/schemas/IDPID","kind":"json-schema","title":"IDPID","data":{"type":"string","description":"Identifier used to authenticate the subscriber for private Hubs that use authorization method providing user ID. For example for SAML protected Hubs.\n","nullable":true,"example":"internal-identifier-at-company.com"}},"components/schemas/BasicFlags":{"id":"components/schemas/BasicFlags","kind":"json-schema","title":"BasicFlags","data":{"type":"object","additionalProperties":false,"required":["deleted"],"properties":{"deleted":{"type":"boolean","description":"Subscriber has been deleted.","example":false}}}},"components/schemas/subscribers_Overview":{"id":"components/schemas/subscribers_Overview","kind":"json-schema","title":"subscribers_Overview","data":{"type":"object","additionalProperties":false,"required":["id","idp_id","flags"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":64},"idp_id":{"type":"string","description":"Identifier used to authenticate the subscriber for private Hubs that use authorization method providing user ID. For example for SAML protected Hubs.\n","nullable":true,"example":"internal-identifier-at-company.com"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Subscriber has been deleted.","example":false}}}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address for a subscription. Exact meaning depends on method name:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email - email address,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sms - phone number,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook - URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"slack - Slack Incoming Webhook URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"teams - MS Teams Incoming Webhook URL."},"children":[]}]}]}]}],"example":"example@statushub.com"}},"components/schemas/SubscriptionMethodName":{"id":"components/schemas/SubscriptionMethodName","kind":"json-schema","title":"SubscriptionMethodName","data":{"type":"string","enum":["email","sms","webhook","slack","teams"],"example":"email"}},"components/schemas/ServicesSelectionParam":{"id":"components/schemas/ServicesSelectionParam","kind":"json-schema","title":"ServicesSelectionParam","data":{"type":"object","additionalProperties":false,"description":"\"all\" has precedence over \"services\". If \"all\" is false, \"services\" can't be empty. If \"all\" is true, \"services\" value is being ignored\n","properties":{"all":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it means that Subscription is subscribed to all current and future Services in current Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be empty."},"children":[]}]}]}],"default":false,"example":false},"service_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"StatusHub ID's of services to which Subscription should be subscribed to."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If contains same values as all Service ID's for current Hub, it automatically implies "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so subscribing to all current and future Services for current Hub."},"children":[]}]}]}],"items":{"type":"integer"},"example":[449,24221,2]}}}},"components/schemas/Configuration":{"id":"components/schemas/Configuration","kind":"json-schema","title":"Configuration","data":{"type":"object","additionalProperties":false,"description":"Additional configuration for this method name or this Subscription\n","properties":{"short_messages":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for Slack subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values explanation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this subscription will receive regular notification payload,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this subscription will receive smaller version"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of notifications with less data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example affected services list will not be included."},"children":[]}]}]}]}],"default":false},"content_type":{"type":"string","enum":["application/x-www-form-urlencoded","application/json"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for webhook subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies what content type will be used to encode"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notification payload."},"children":[]}]}]}],"default":"application/x-www-form-urlencoded"}},"example":{"content_type":"application/json"}}},"components/schemas/components-Label":{"id":"components/schemas/components-Label","kind":"json-schema","title":"components-Label","data":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information to add better meaning for subscription."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used to add responsible person name or team to SMS or URL-based subscriptions where address alone is not enough to know who is receiving the notifications."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Not available for email subscriptions."},"children":[]}]}]}],"example":"Responsible person name"}},"components/schemas/LessVerbose":{"id":"components/schemas/LessVerbose","kind":"json-schema","title":"LessVerbose","data":{"type":"boolean","description":"Subscription will receive the minimum number of notifications per incident - typically first and final.\n","default":false,"example":true}},"components/schemas/Protected":{"id":"components/schemas/Protected","kind":"json-schema","title":"Protected","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription is protected which means it doesn't have the ability of self-service like editing the services list or subscription options as well as doesn't have the ability to self-unsubscribe."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used for group email subscriptions where without this option, any member of an email group could use unsubscribe through the unsubscribe link sent in every notification. And as a result the whole group would stop receiving notifications."},"children":[]}]}]}],"default":false,"example":false}},"components/schemas/SubscriberIDParam":{"id":"components/schemas/SubscriberIDParam","kind":"json-schema","title":"SubscriberIDParam","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Subscriber. If not provided, StatusHub will create new, empty Subscriber record."},"children":[]}]}]}],"example":9}},"components/schemas/CreatePayload":{"id":"components/schemas/CreatePayload","kind":"json-schema","title":"CreatePayload","data":{"type":"object","additionalProperties":false,"required":["address","method_name","services_selection"],"properties":{"address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address for a subscription. Exact meaning depends on method name:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email - email address,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sms - phone number,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook - URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"slack - Slack Incoming Webhook URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"teams - MS Teams Incoming Webhook URL."},"children":[]}]}]}]}],"example":"example@statushub.com"},"method_name":{"type":"string","enum":["email","sms","webhook","slack","teams"],"example":"email"},"services_selection":{"type":"object","additionalProperties":false,"description":"\"all\" has precedence over \"services\". If \"all\" is false, \"services\" can't be empty. If \"all\" is true, \"services\" value is being ignored\n","properties":{"all":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it means that Subscription is subscribed to all current and future Services in current Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be empty."},"children":[]}]}]}],"default":false,"example":false},"service_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"StatusHub ID's of services to which Subscription should be subscribed to."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If contains same values as all Service ID's for current Hub, it automatically implies "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so subscribing to all current and future Services for current Hub."},"children":[]}]}]}],"items":{"type":"integer"},"example":[449,24221,2]}}},"configuration":{"type":"object","additionalProperties":false,"description":"Additional configuration for this method name or this Subscription\n","properties":{"short_messages":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for Slack subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values explanation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this subscription will receive regular notification payload,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this subscription will receive smaller version"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of notifications with less data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example affected services list will not be included."},"children":[]}]}]}]}],"default":false},"content_type":{"type":"string","enum":["application/x-www-form-urlencoded","application/json"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for webhook subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies what content type will be used to encode"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notification payload."},"children":[]}]}]}],"default":"application/x-www-form-urlencoded"}},"example":{"content_type":"application/json"}},"label":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information to add better meaning for subscription."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used to add responsible person name or team to SMS or URL-based subscriptions where address alone is not enough to know who is receiving the notifications."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Not available for email subscriptions."},"children":[]}]}]}],"example":"Responsible person name"},"less_verbose":{"type":"boolean","description":"Subscription will receive the minimum number of notifications per incident - typically first and final.\n","default":false,"example":true},"protected":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription is protected which means it doesn't have the ability of self-service like editing the services list or subscription options as well as doesn't have the ability to self-unsubscribe."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used for group email subscriptions where without this option, any member of an email group could use unsubscribe through the unsubscribe link sent in every notification. And as a result the whole group would stop receiving notifications."},"children":[]}]}]}],"default":false,"example":false},"subscriber_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Subscriber. If not provided, StatusHub will create new, empty Subscriber record."},"children":[]}]}]}],"example":9}}}},"components/schemas/subscribers_CreatePayload":{"id":"components/schemas/subscribers_CreatePayload","kind":"json-schema","title":"subscribers_CreatePayload","data":{"type":"object","additionalProperties":false,"required":["subscriptions"],"properties":{"idp_id":{"type":"string","description":"Identifier used to authenticate the subscriber for private Hubs that use authorization method providing user ID. For example for SAML protected Hubs.\n","nullable":true,"example":"internal-identifier-at-company.com"},"subscriptions":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["address","method_name","services_selection"],"properties":{"address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address for a subscription. Exact meaning depends on method name:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email - email address,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sms - phone number,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook - URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"slack - Slack Incoming Webhook URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"teams - MS Teams Incoming Webhook URL."},"children":[]}]}]}]}],"example":"example@statushub.com"},"method_name":{"type":"string","enum":["email","sms","webhook","slack","teams"],"example":"email"},"services_selection":{"type":"object","additionalProperties":false,"description":"\"all\" has precedence over \"services\". If \"all\" is false, \"services\" can't be empty. If \"all\" is true, \"services\" value is being ignored\n","properties":{"all":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it means that Subscription is subscribed to all current and future Services in current Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be empty."},"children":[]}]}]}],"default":false,"example":false},"service_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"StatusHub ID's of services to which Subscription should be subscribed to."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If contains same values as all Service ID's for current Hub, it automatically implies "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so subscribing to all current and future Services for current Hub."},"children":[]}]}]}],"items":{"type":"integer"},"example":[449,24221,2]}}},"configuration":{"type":"object","additionalProperties":false,"description":"Additional configuration for this method name or this Subscription\n","properties":{"short_messages":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for Slack subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values explanation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this subscription will receive regular notification payload,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this subscription will receive smaller version"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of notifications with less data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example affected services list will not be included."},"children":[]}]}]}]}],"default":false},"content_type":{"type":"string","enum":["application/x-www-form-urlencoded","application/json"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for webhook subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies what content type will be used to encode"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notification payload."},"children":[]}]}]}],"default":"application/x-www-form-urlencoded"}},"example":{"content_type":"application/json"}},"label":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information to add better meaning for subscription."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used to add responsible person name or team to SMS or URL-based subscriptions where address alone is not enough to know who is receiving the notifications."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Not available for email subscriptions."},"children":[]}]}]}],"example":"Responsible person name"},"less_verbose":{"type":"boolean","description":"Subscription will receive the minimum number of notifications per incident - typically first and final.\n","default":false,"example":true},"protected":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription is protected which means it doesn't have the ability of self-service like editing the services list or subscription options as well as doesn't have the ability to self-unsubscribe."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used for group email subscriptions where without this option, any member of an email group could use unsubscribe through the unsubscribe link sent in every notification. And as a result the whole group would stop receiving notifications."},"children":[]}]}]}],"default":false,"example":false},"subscriber_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Subscriber. If not provided, StatusHub will create new, empty Subscriber record."},"children":[]}]}]}],"example":9}}},"minItems":1}}}},"components/schemas/subscribers_Details":{"id":"components/schemas/subscribers_Details","kind":"json-schema","title":"subscribers_Details","data":{"type":"object","additionalProperties":false,"required":["id","idp_id","flags","created_at","updated_at"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":67},"idp_id":{"type":"string","description":"Identifier used to authenticate the subscriber for private Hubs that use authorization method providing user ID. For example for SAML protected Hubs.\n","nullable":true,"example":"internal-identifier-at-company.com"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Subscriber has been deleted.","example":false}}},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}}},"components/schemas/UpdatePayload":{"id":"components/schemas/UpdatePayload","kind":"json-schema","title":"UpdatePayload","data":{"type":"object","additionalProperties":false,"properties":{"idp_id":{"type":"string","description":"Identifier used to authenticate the subscriber for private Hubs that use authorization method providing user ID. For example for SAML protected Hubs.\n","nullable":true,"example":"internal-identifier-at-company.com"}}}},"components/schemas/ServiceSelectionOverview":{"id":"components/schemas/ServiceSelectionOverview","kind":"json-schema","title":"ServiceSelectionOverview","data":{"type":"object","additionalProperties":false,"required":["all"],"properties":{"all":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this subscription subscribed to all services in the Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Subscription subscribed to all services will be notified about events affecting the services even if service was added after the subscription has been created."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If subscription is not subscribed to all services then any notification affecting only newly added service will not be sent to this subscription."},"children":[]}]}]}],"example":true}}}},"components/schemas/components-BasicFlags":{"id":"components/schemas/components-BasicFlags","kind":"json-schema","title":"Basic flags","data":{"type":"object","title":"Basic flags","additionalProperties":false,"required":["deleted"],"properties":{"deleted":{"type":"boolean","description":"Subscription has been deleted.","example":false}}}},"components/schemas/ExtendedFlags":{"id":"components/schemas/ExtendedFlags","kind":"json-schema","title":"Extended flags","data":{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":["deleted","less_verbose","credentials","protected"],"properties":{"deleted":{"type":"boolean","description":"Subscription has been deleted.","example":false},"less_verbose":{"type":"boolean","description":"Subscription will receive the minimum number of notifications per incident - typically first and final.\n","default":false,"example":true},"credentials":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription use additional credentials in request headers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid only for webhook subscriptions."},"children":[]}]}]}],"example":false},"protected":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription is protected which means it doesn't have the ability of self-service like editing the services list or subscription options as well as doesn't have the ability to self-unsubscribe."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used for group email subscriptions where without this option, any member of an email group could use unsubscribe through the unsubscribe link sent in every notification. And as a result the whole group would stop receiving notifications."},"children":[]}]}]}],"default":false,"example":false}}}},"components/schemas/subscriptions_Overview":{"id":"components/schemas/subscriptions_Overview","kind":"json-schema","title":"subscriptions_Overview","data":{"type":"object","additionalProperties":false,"required":["id","address","method_name","subscriber_id","services_selection","flags"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":78},"address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address for a subscription. Exact meaning depends on method name:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email - email address,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sms - phone number,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook - URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"slack - Slack Incoming Webhook URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"teams - MS Teams Incoming Webhook URL."},"children":[]}]}]}]}],"example":"example@statushub.com"},"method_name":{"type":"string","enum":["email","sms","webhook","slack","teams"],"example":"email"},"subscriber_id":{"type":"integer","minimum":1,"x-autoid":true,"example":79},"label":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information to add better meaning for subscription."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used to add responsible person name or team to SMS or URL-based subscriptions where address alone is not enough to know who is receiving the notifications."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Not available for email subscriptions."},"children":[]}]}]}],"example":"Responsible person name"},"services_selection":{"type":"object","additionalProperties":false,"required":[],"properties":{"all":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this subscription subscribed to all services in the Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Subscription subscribed to all services will be notified about events affecting the services even if service was added after the subscription has been created."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If subscription is not subscribed to all services then any notification affecting only newly added service will not be sent to this subscription."},"children":[]}]}]}],"example":true}}},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Subscription has been deleted.","example":false}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Subscription has been deleted.","example":false},"less_verbose":{"type":"boolean","description":"Subscription will receive the minimum number of notifications per incident - typically first and final.\n","default":false,"example":true},"credentials":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription use additional credentials in request headers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid only for webhook subscriptions."},"children":[]}]}]}],"example":false},"protected":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription is protected which means it doesn't have the ability of self-service like editing the services list or subscription options as well as doesn't have the ability to self-unsubscribe."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used for group email subscriptions where without this option, any member of an email group could use unsubscribe through the unsubscribe link sent in every notification. And as a result the whole group would stop receiving notifications."},"children":[]}]}]}],"default":false,"example":false}}}]}}}},"components/schemas/ServiceSelectionItem":{"id":"components/schemas/ServiceSelectionItem","kind":"json-schema","title":"ServiceSelectionItem","data":{"type":"object","additionalProperties":false,"required":["id","name","group_name","archived"],"properties":{"id":{"type":"integer","example":1234},"name":{"type":"string","example":"Service name"},"group_name":{"type":"string","example":"Group name"},"archived":{"type":"boolean","example":false}}}},"components/schemas/ServiceSelectionDetails":{"id":"components/schemas/ServiceSelectionDetails","kind":"json-schema","title":"ServiceSelectionDetails","data":{"type":"object","additionalProperties":false,"required":["all","services"],"properties":{"all":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this subscription subscribed to all services in the Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Subscription subscribed to all services will be notified about events affecting the services even if service was added after the subscription has been created."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If subscription is not subscribed to all services then any notification affecting only newly added service will not be sent to this subscription."},"children":[]}]}]}],"example":true},"services":{"type":"array","nullable":true,"items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","example":1234},"name":{"type":"string","example":"Service name"},"group_name":{"type":"string","example":"Group name"},"archived":{"type":"boolean","example":false}}}}}}},"components/schemas/subscriptions_Details":{"id":"components/schemas/subscriptions_Details","kind":"json-schema","title":"subscriptions_Details","data":{"type":"object","additionalProperties":false,"required":["id","address","method_name","subscriber_id","services_selection","label","created_at","updated_at"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":86},"address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address for a subscription. Exact meaning depends on method name:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email - email address,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sms - phone number,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook - URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"slack - Slack Incoming Webhook URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"teams - MS Teams Incoming Webhook URL."},"children":[]}]}]}]}],"example":"example@statushub.com"},"configuration":{"type":"object","additionalProperties":false,"description":"Additional configuration for this method name or this Subscription\n","properties":{"short_messages":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for Slack subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values explanation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this subscription will receive regular notification payload,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this subscription will receive smaller version"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of notifications with less data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example affected services list will not be included."},"children":[]}]}]}]}],"default":false},"content_type":{"type":"string","enum":["application/x-www-form-urlencoded","application/json"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for webhook subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies what content type will be used to encode"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notification payload."},"children":[]}]}]}],"default":"application/x-www-form-urlencoded"}},"example":{"content_type":"application/json"}},"method_name":{"type":"string","enum":["email","sms","webhook","slack","teams"],"example":"email"},"subscriber_id":{"type":"integer","minimum":1,"x-autoid":true,"example":87},"services_selection":{"type":"object","additionalProperties":false,"required":[],"properties":{"all":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this subscription subscribed to all services in the Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Subscription subscribed to all services will be notified about events affecting the services even if service was added after the subscription has been created."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If subscription is not subscribed to all services then any notification affecting only newly added service will not be sent to this subscription."},"children":[]}]}]}],"example":true},"services":{"type":"array","nullable":true,"items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","example":1234},"name":{"type":"string","example":"Service name"},"group_name":{"type":"string","example":"Group name"},"archived":{"type":"boolean","example":false}}}}}},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Subscription has been deleted.","example":false}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Subscription has been deleted.","example":false},"less_verbose":{"type":"boolean","description":"Subscription will receive the minimum number of notifications per incident - typically first and final.\n","default":false,"example":true},"credentials":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription use additional credentials in request headers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid only for webhook subscriptions."},"children":[]}]}]}],"example":false},"protected":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription is protected which means it doesn't have the ability of self-service like editing the services list or subscription options as well as doesn't have the ability to self-unsubscribe."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used for group email subscriptions where without this option, any member of an email group could use unsubscribe through the unsubscribe link sent in every notification. And as a result the whole group would stop receiving notifications."},"children":[]}]}]}],"default":false,"example":false}}}]},"label":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information to add better meaning for subscription."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used to add responsible person name or team to SMS or URL-based subscriptions where address alone is not enough to know who is receiving the notifications."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Not available for email subscriptions."},"children":[]}]}]}],"example":"Responsible person name"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}}},"components/schemas/subscriptions_UpdatePayload":{"id":"components/schemas/subscriptions_UpdatePayload","kind":"json-schema","title":"subscriptions_UpdatePayload","data":{"type":"object","additionalProperties":false,"required":["services_selection"],"properties":{"services_selection":{"type":"object","additionalProperties":false,"description":"\"all\" has precedence over \"services\". If \"all\" is false, \"services\" can't be empty. If \"all\" is true, \"services\" value is being ignored\n","properties":{"all":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it means that Subscription is subscribed to all current and future Services in current Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be empty."},"children":[]}]}]}],"default":false,"example":false},"service_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"StatusHub ID's of services to which Subscription should be subscribed to."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If contains same values as all Service ID's for current Hub, it automatically implies "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so subscribing to all current and future Services for current Hub."},"children":[]}]}]}],"items":{"type":"integer"},"example":[449,24221,2]}}},"configuration":{"type":"object","additionalProperties":false,"description":"Additional configuration for this method name or this Subscription\n","properties":{"short_messages":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for Slack subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values explanation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this subscription will receive regular notification payload,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this subscription will receive smaller version"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of notifications with less data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example affected services list will not be included."},"children":[]}]}]}]}],"default":false},"content_type":{"type":"string","enum":["application/x-www-form-urlencoded","application/json"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for webhook subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies what content type will be used to encode"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notification payload."},"children":[]}]}]}],"default":"application/x-www-form-urlencoded"}},"example":{"content_type":"application/json"}},"label":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information to add better meaning for subscription."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used to add responsible person name or team to SMS or URL-based subscriptions where address alone is not enough to know who is receiving the notifications."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Not available for email subscriptions."},"children":[]}]}]}],"example":"Responsible person name"},"less_verbose":{"type":"boolean","description":"Subscription will receive the minimum number of notifications per incident - typically first and final.\n","default":false,"example":true},"protected":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription is protected which means it doesn't have the ability of self-service like editing the services list or subscription options as well as doesn't have the ability to self-unsubscribe."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used for group email subscriptions where without this option, any member of an email group could use unsubscribe through the unsubscribe link sent in every notification. And as a result the whole group would stop receiving notifications."},"children":[]}]}]}],"default":false,"example":false}}}},"components/schemas/components-Flags":{"id":"components/schemas/components-Flags","kind":"json-schema","title":"components-Flags","data":{"type":"object","additionalProperties":false,"required":["deleted"],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this group archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the services in archived group are still visible on Hub Page with direct event link."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this group deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the services in deleted group are not visible on Hub Page, even with direct event link."},"children":[]}]}]}]}}}},"components/schemas/groups_Overview":{"id":"components/schemas/groups_Overview","kind":"json-schema","title":"groups_Overview","data":{"type":"object","additionalProperties":false,"required":["id","name","flags"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":100},"name":{"type":"string"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this group archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the services in archived group are still visible on Hub Page with direct event link."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this group deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the services in deleted group are not visible on Hub Page, even with direct event link."},"children":[]}]}]}]}}}}}},"components/schemas/groups_Payload":{"id":"components/schemas/groups_Payload","kind":"json-schema","title":"groups_Payload","data":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"}}}},"components/schemas/groups_Details":{"id":"components/schemas/groups_Details","kind":"json-schema","title":"groups_Details","data":{"type":"object","additionalProperties":false,"required":["id","name","flags","created_at","updated_at"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":101},"name":{"type":"string"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this group archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the services in archived group are still visible on Hub Page with direct event link."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this group deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the services in deleted group are not visible on Hub Page, even with direct event link."},"children":[]}]}]}]}}}}}},"components/schemas/services_components-Flags":{"id":"components/schemas/services_components-Flags","kind":"json-schema","title":"services_components-Flags","data":{"type":"object","additionalProperties":false,"required":["deleted"],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this service archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the archived services are still visible on Hub Page with direct event link."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this service deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the deleted services are still visible on Hub Page with direct event link."},"children":[]}]}]}]}}}},"components/schemas/services_Overview":{"id":"components/schemas/services_Overview","kind":"json-schema","title":"services_Overview","data":{"type":"object","additionalProperties":false,"required":["id","custom_id","name","group_id","flags"],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":102},"custom_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a property that can be used to assign an external identifier to a service. This identifier can be used, for example, to synchronize monitored entities with services in StatusHub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has to be unique within the scope of a Hub."},"children":[]}]}]}],"nullable":true},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":103},"name":{"type":"string"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this service archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the archived services are still visible on Hub Page with direct event link."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this service deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the deleted services are still visible on Hub Page with direct event link."},"children":[]}]}]}]}}}}}},"components/schemas/components-Description":{"id":"components/schemas/components-Description","kind":"json-schema","title":"components-Description","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to add more information describing the service on a Hub Page. Description is visible inside a tooltip in a Hub Page."},"children":[]}]}]}],"nullable":true}},"components/schemas/PublicName":{"id":"components/schemas/PublicName","kind":"json-schema","title":"PublicName","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an optional name that can be used to show different name for visitors of Hub Page and subscribers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typical use-case is to use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describing customer or contractor name so members using StatusHub Control Panel can distinguish the services easily and use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with generic or obfuscated name to not disclose the actual name of customer or subcontractor especially on public Hubs."},"children":[]}]}]}],"nullable":true}},"components/schemas/services_Payload":{"id":"components/schemas/services_Payload","kind":"json-schema","title":"services_Payload","data":{"type":"object","additionalProperties":false,"required":["group_id","name"],"properties":{"custom_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a property that can be used to assign an external identifier to a service. This identifier can be used, for example, to synchronize monitored entities with services in StatusHub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has to be unique within the scope of a Hub."},"children":[]}]}]}],"nullable":true},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to add more information describing the service on a Hub Page. Description is visible inside a tooltip in a Hub Page."},"children":[]}]}]}],"nullable":true},"group_id":{"type":"integer","minimum":1,"x-autoid":true},"name":{"type":"string"},"public_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an optional name that can be used to show different name for visitors of Hub Page and subscribers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typical use-case is to use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describing customer or contractor name so members using StatusHub Control Panel can distinguish the services easily and use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with generic or obfuscated name to not disclose the actual name of customer or subcontractor especially on public Hubs."},"children":[]}]}]}],"nullable":true}}}},"components/schemas/Token":{"id":"components/schemas/Token","kind":"json-schema","title":"Token","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique token value that is being used to connect external integrations to StatusHub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically all integration URLs are using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value so knowing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value allows to construct various integrations URLs programmatically."},"children":[]}]}]}]}},"components/schemas/services_Details":{"id":"components/schemas/services_Details","kind":"json-schema","title":"services_Details","data":{"type":"object","additionalProperties":false,"required":["id","custom_id","name","group_id","flags","description","token","created_at","updated_at","public_name"],"properties":{"custom_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a property that can be used to assign an external identifier to a service. This identifier can be used, for example, to synchronize monitored entities with services in StatusHub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has to be unique within the scope of a Hub."},"children":[]}]}]}],"nullable":true},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to add more information describing the service on a Hub Page. Description is visible inside a tooltip in a Hub Page."},"children":[]}]}]}],"nullable":true},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":106},"id":{"type":"integer","minimum":1,"x-autoid":true,"example":107},"name":{"type":"string"},"public_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an optional name that can be used to show different name for visitors of Hub Page and subscribers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typical use-case is to use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describing customer or contractor name so members using StatusHub Control Panel can distinguish the services easily and use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with generic or obfuscated name to not disclose the actual name of customer or subcontractor especially on public Hubs."},"children":[]}]}]}],"nullable":true},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique token value that is being used to connect external integrations to StatusHub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically all integration URLs are using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value so knowing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value allows to construct various integrations URLs programmatically."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this service archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the archived services are still visible on Hub Page with direct event link."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this service deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the deleted services are still visible on Hub Page with direct event link."},"children":[]}]}]}]}}}}}},"components/schemas/services_UpdatePayload":{"id":"components/schemas/services_UpdatePayload","kind":"json-schema","title":"services_UpdatePayload","data":{"type":"object","additionalProperties":false,"properties":{"custom_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a property that can be used to assign an external identifier to a service. This identifier can be used, for example, to synchronize monitored entities with services in StatusHub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has to be unique within the scope of a Hub."},"children":[]}]}]}],"nullable":true},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to add more information describing the service on a Hub Page. Description is visible inside a tooltip in a Hub Page."},"children":[]}]}]}],"nullable":true},"group_id":{"type":"integer","minimum":1,"x-autoid":true},"name":{"type":"string"},"public_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an optional name that can be used to show different name for visitors of Hub Page and subscribers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typical use-case is to use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describing customer or contractor name so members using StatusHub Control Panel can distinguish the services easily and use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with generic or obfuscated name to not disclose the actual name of customer or subcontractor especially on public Hubs."},"children":[]}]}]}],"nullable":true}}}},"components/schemas/components-Enabled":{"id":"components/schemas/components-Enabled","kind":"json-schema","title":"components-Enabled","data":{"type":"boolean","description":"Is integration enabled on this service\n","example":true}},"components/schemas/Slug":{"id":"components/schemas/Slug","kind":"json-schema","title":"Slug","data":{"type":"string","enum":["generic_hook","generic_hook_v2","ilert","isdownapp","new_relic","opsgenie","pager_duty","pingdom","site_247","statusgator","still_alive","uptime_robot","uptrends","victor_ops"],"example":"generic_hook_v2"}},"components/schemas/Version":{"id":"components/schemas/Version","kind":"json-schema","title":"Version","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the integration."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently available versions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - basic integrations available in StatusHub for long time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - more capable integrations. All newly introduced"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations will be added in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" version."},"children":[]}]}]}]}],"enum":["v1","v2"],"example":"v2"}},"components/schemas/integrations_Overview":{"id":"components/schemas/integrations_Overview","kind":"json-schema","title":"integrations_Overview","data":{"type":"object","additionalProperties":false,"required":["enabled","slug","version"],"properties":{"enabled":{"type":"boolean","description":"Is integration enabled on this service\n","example":true},"slug":{"type":"string","enum":["generic_hook","generic_hook_v2","ilert","isdownapp","new_relic","opsgenie","pager_duty","pingdom","site_247","statusgator","still_alive","uptime_robot","uptrends","victor_ops"],"example":"generic_hook_v2"},"version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the integration."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently available versions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - basic integrations available in StatusHub for long time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - more capable integrations. All newly introduced"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations will be added in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" version."},"children":[]}]}]}]}],"enum":["v1","v2"],"example":"v2"}}}},"components/schemas/components-URL":{"id":"components/schemas/components-URL","kind":"json-schema","title":"components-URL","data":{"type":"string","format":"uri","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Except for Pingdom integration, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is unique per-Service URL that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should be used to connect 3rd party service to StatusHub Service."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior of this field varies between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations, this URL share same token part between"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is never blank,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations, each integration may use different token."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is blank if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integration is not enabled."},"children":[]}]}]}]}],"example":"https://app.statushub.io/hooks/generic_hook_v2?token=a18331da-19a5-46f1-8bfa-06a6a31f1d10"}},"components/schemas/integrations_Details":{"id":"components/schemas/integrations_Details","kind":"json-schema","title":"integrations_Details","data":{"type":"object","additionalProperties":false,"required":["enabled","slug","version","url"],"properties":{"enabled":{"type":"boolean","description":"Is integration enabled on this service\n","example":true},"slug":{"type":"string","enum":["generic_hook","generic_hook_v2","ilert","isdownapp","new_relic","opsgenie","pager_duty","pingdom","site_247","statusgator","still_alive","uptime_robot","uptrends","victor_ops"],"example":"generic_hook_v2"},"version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the integration."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently available versions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - basic integrations available in StatusHub for long time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - more capable integrations. All newly introduced"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations will be added in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" version."},"children":[]}]}]}]}],"enum":["v1","v2"],"example":"v2"},"url":{"type":"string","format":"uri","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Except for Pingdom integration, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is unique per-Service URL that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should be used to connect 3rd party service to StatusHub Service."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior of this field varies between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations, this URL share same token part between"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is never blank,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations, each integration may use different token."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is blank if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integration is not enabled."},"children":[]}]}]}]}],"example":"https://app.statushub.io/hooks/generic_hook_v2?token=a18331da-19a5-46f1-8bfa-06a6a31f1d10"}}}},"components/schemas/EnabledParam":{"id":"components/schemas/EnabledParam","kind":"json-schema","title":"EnabledParam","data":{"type":"boolean","description":"Should integration be enabled on this service\n","example":true}},"components/schemas/integrations_UpdatePayload":{"id":"components/schemas/integrations_UpdatePayload","kind":"json-schema","title":"integrations_UpdatePayload","data":{"type":"object","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Should integration be enabled on this service\n","example":true}}}},"components/schemas/connected_services_Payload":{"id":"components/schemas/connected_services_Payload","kind":"json-schema","title":"connected_services_Payload","data":{"type":"object","additionalProperties":false,"required":["service_id"],"properties":{"service_id":{"type":"integer","minimum":1,"x-autoid":true}}}},"components/schemas/Date":{"id":"components/schemas/Date","kind":"json-schema","title":"Date","data":{"type":"string","format":"date","description":"Full-date notation as defined by RFC 3339, section 5.6.\n","example":"2025-01-01"}},"components/schemas/UptimeValue":{"id":"components/schemas/UptimeValue","kind":"json-schema","title":"UptimeValue","data":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uptime value for the requested period. Value is between 0.0 and 1.0, where 0 means no uptime and 1 means 100% uptime."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Uptime value is always rounded down."},"children":[]}]}]}],"minimum":0,"maximum":1,"example":0.9995}},"components/schemas/UptimeDetails":{"id":"components/schemas/UptimeDetails","kind":"json-schema","title":"UptimeDetails","data":{"type":"object","additionalProperties":false,"required":["uptime"],"properties":{"uptime":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uptime value for the requested period. Value is between 0.0 and 1.0, where 0 means no uptime and 1 means 100% uptime."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Uptime value is always rounded down."},"children":[]}]}]}],"minimum":0,"maximum":1,"example":0.9995}}}},"components/schemas/DailyUptimeDetails":{"id":"components/schemas/DailyUptimeDetails","kind":"json-schema","title":"DailyUptimeDetails","data":{"type":"object","additionalProperties":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uptime value for the requested period. Value is between 0.0 and 1.0, where 0 means no uptime and 1 means 100% uptime."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Uptime value is always rounded down."},"children":[]}]}]}],"minimum":0,"maximum":1,"example":0.9995},"example":{"2023-01-01":0.9995,"2023-01-02":1,"2023-01-03":0.68351,"2023-01-04":0.99999,"2023-01-05":1}}},"components/schemas/external_applications_components-Enabled":{"id":"components/schemas/external_applications_components-Enabled","kind":"json-schema","title":"external_applications_components-Enabled","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of app:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will work for as long as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used token is valid,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will not work even if used token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is valid."},"children":[]}]}]}]}],"example":true}},"components/schemas/components-Slug":{"id":"components/schemas/components-Slug","kind":"json-schema","title":"components-Slug","data":{"type":"string","description":"External Application slug","example":"widget"}},"components/schemas/external_applications_Overview":{"id":"components/schemas/external_applications_Overview","kind":"json-schema","title":"external_applications_Overview","data":{"type":"object","additionalProperties":false,"required":["enabled","slug"],"properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of app:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will work for as long as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used token is valid,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will not work even if used token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is valid."},"children":[]}]}]}]}],"example":true},"slug":{"type":"string","description":"External Application slug","example":"widget"}}}},"components/schemas/external_applications_Details":{"id":"components/schemas/external_applications_Details","kind":"json-schema","title":"external_applications_Details","data":{"type":"object","additionalProperties":false,"required":["enabled","slug"],"properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of app:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will work for as long as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used token is valid,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will not work even if used token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is valid."},"children":[]}]}]}]}],"example":true},"slug":{"type":"string","description":"External Application slug","example":"widget"}}}},"components/schemas/external_applications_Payload":{"id":"components/schemas/external_applications_Payload","kind":"json-schema","title":"external_applications_Payload","data":{"type":"object","additionalProperties":false,"properties":{"enabled":{"type":"boolean"}}}},"components/schemas/components-Token":{"id":"components/schemas/components-Token","kind":"json-schema","title":"components-Token","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token used when installing StatusHub application/widget."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one token is valid at a time."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to rotate for example compromised token reset token operation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can be used."},"children":[]}]}]}],"example":"0bf65c9c5aca1133e906abf80f02fd9f8066aa94"}},"components/schemas/DetailsWithToken":{"id":"components/schemas/DetailsWithToken","kind":"json-schema","title":"DetailsWithToken","data":{"type":"object","description":"Returned for all External Apps except for Status API.\n","additionalProperties":false,"required":["enabled","slug","token"],"properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of app:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will work for as long as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used token is valid,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will not work even if used token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is valid."},"children":[]}]}]}]}],"example":true},"slug":{"type":"string","description":"External Application slug","example":"widget"},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token used when installing StatusHub application/widget."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one token is valid at a time."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to rotate for example compromised token reset token operation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can be used."},"children":[]}]}]}],"example":"0bf65c9c5aca1133e906abf80f02fd9f8066aa94"}}}},"components/schemas/ClientID":{"id":"components/schemas/ClientID","kind":"json-schema","title":"ClientID","data":{"type":"string","description":"Client ID used for Status API application authentication","example":"87b4c329f0075aa5958682785bed5c37009758de"}},"components/schemas/ClientSecret":{"id":"components/schemas/ClientSecret","kind":"json-schema","title":"ClientSecret","data":{"type":"string","description":"Client Secret used for Status API application authentication","example":"ba83af8c4913b4c150c0945f93cbb3377611ce41"}},"components/schemas/StatusApiDetailsWithCredentials":{"id":"components/schemas/StatusApiDetailsWithCredentials","kind":"json-schema","title":"StatusApiDetailsWithCredentials","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned for Status API which has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_secret"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":false,"required":["enabled","slug","client_id","client_secret"],"properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of app:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will work for as long as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used token is valid,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will not work even if used token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is valid."},"children":[]}]}]}]}],"example":true},"slug":{"type":"string","description":"External Application slug","example":"widget"},"client_id":{"type":"string","description":"Client ID used for Status API application authentication","example":"87b4c329f0075aa5958682785bed5c37009758de"},"client_secret":{"type":"string","description":"Client Secret used for Status API application authentication","example":"ba83af8c4913b4c150c0945f93cbb3377611ce41"}}}},"schema_0":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":15},"author":{"type":"string","nullable":true,"description":"Author email"},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of incident as visible on Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If there is draft IncidentUpdate that changes the title, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not reflect this change because the draft update is not published and therefore not visible on Hub Page."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"start_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"end_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event end. If not set it means that the event has not ended yet."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Does this incident has any unpublished updates (drafts)."}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services has been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Does this incident has any unpublished updates (drafts)."},"follow_up":{"type":"boolean","description":"Is it a follow-up incident."},"published":{"type":"boolean","description":"Event was published on Hub Page."},"unconfirmed":{"type":"boolean","description":"Is it an unconfirmed incident. Unconfirmed incidents are still visible on Hub Page.\n"}}}]}}},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","enum":["true","false","all"],"default":"all"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","default":"false","enum":["true","false","all"]},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","enum":["created_at","start_time","updated_at"],"default":"start_time"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","enum":["asc","desc"],"default":"desc"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"string","default":"1900-01-01T00:00:00Z","format":"date-time"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","default":"2199-01-01T00:00:00Z","format":"date-time"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","example":"flags"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":1},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":25},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":[],"properties":{"current_page":{"type":"integer","minimum":1,"example":1},"page_count":{"type":"integer","minimum":1,"example":4},"per_page":{"type":"integer","minimum":1,"maximum":100,"example":25},"total":{"type":"integer","minimum":0,"example":1024}}},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":13},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of incident as visible on Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If there is draft IncidentUpdate that changes the title, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not reflect this change because the draft update is not published and therefore not visible on Hub Page."},"children":[]}]}]}]},"last_incident_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Exact meaning may depend on use case and there is just one restriction:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can't be used as type of a first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]}]}]}],"enum":["investigating","identified","monitoring","resolved"],"example":"investigating"},"start_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"end_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event end. If not set it means that the event has not ended yet."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Does this incident has any unpublished updates (drafts)."}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services has been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Does this incident has any unpublished updates (drafts)."},"follow_up":{"type":"boolean","description":"Is it a follow-up incident."},"published":{"type":"boolean","description":"Event was published on Hub Page."},"unconfirmed":{"type":"boolean","description":"Is it an unconfirmed incident. Unconfirmed incidents are still visible on Hub Page.\n"}}}]}}}}}}]},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"message":{"type":"string"}}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":25},"author":{"type":"string","nullable":true,"description":"Author email"},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of this update. May be different from current incident title."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Incident title may be changed during the duration of incident and therefore some updates may reflect previous title."},"children":[]}]}]}]},"body":{"type":"string","default":"","example":"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"start_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamps of a Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"incident_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Exact meaning may depend on use case and there is just one restriction:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can't be used as type of a first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]}]}]}],"enum":["investigating","identified","monitoring","resolved"],"example":"investigating"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Incident or Incident Update:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Not published on Hub Page,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unconfirmed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page but marked as unconfirmed,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page."},"children":[]}]}]}]}],"default":"published","example":"published","nullable":true,"enum":["draft","unconfirmed","published"]},"service_statuses":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":61},"service_id":{"type":"integer","minimum":1,"x-autoid":true,"example":62},"service_name":{"type":"string"},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":63},"group_name":{"type":"string"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean"},"archived":{"type":"boolean"}}}}}},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Incident Update a draft - meaning it wasn't published on a Hub Page.\n"}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services has been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Incident Update a draft - meaning it wasn't published on a Hub Page.\n"},"unconfirmed":{"type":"boolean","description":"Is it an unconfirmed Incident Update. Unconfirmed can only be a first Incident Update of an Incident. Unconfirmed Incident Updates are still visible on Hub Page.\n"},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is it a silent Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Silent event does not result in notifications being sent to subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}]}}}]}}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"string","enum":["start_time","created_at","updated_at"],"default":"start_time"},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":[],"properties":{"current_page":{"type":"integer","minimum":1,"example":1},"page_count":{"type":"integer","minimum":1,"example":4},"per_page":{"type":"integer","minimum":1,"maximum":100,"example":25},"total":{"type":"integer","minimum":0,"example":1024}}},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":16},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of this update. May be different from current incident title."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Incident title may be changed during the duration of incident and therefore some updates may reflect previous title."},"children":[]}]}]}]},"incident_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Exact meaning may depend on use case and there is just one restriction:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can't be used as type of a first (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") Incident Update."},"children":[]}]}]}],"enum":["investigating","identified","monitoring","resolved"],"example":"investigating"},"start_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamps of a Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"state":{"type":"string","enum":["undefined","draft","unconfirmed","published"],"description":"Event state","example":"published"},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Incident Update a draft - meaning it wasn't published on a Hub Page.\n"}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services has been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Incident Update a draft - meaning it wasn't published on a Hub Page.\n"},"unconfirmed":{"type":"boolean","description":"Is it an unconfirmed Incident Update. Unconfirmed can only be a first Incident Update of an Incident. Unconfirmed Incident Updates are still visible on Hub Page.\n"},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is it a silent Incident Update."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Silent event does not result in notifications being sent to subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}]}}}]}}},"maxItems":10}}}]},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"string"},"author":{"type":"string","nullable":true,"description":"Author email"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text. HTML tags and other forms of formatting are not allowed."},"children":[]}]}]}],"example":"Title of the event"},"body":{"type":"string","default":"","example":"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"},"event_repeat":{"type":"object","nullable":true,"description":"Describes recurring maintenance schedules.\n","properties":{"interval":{"type":"string","description":"How frequent should the event be repeated.\n","enum":["day","week","two_weeks","month","year"]},"interval_options":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional configuration for some of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"enabled_days":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"interval\": \"day\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of enabled days indexes (0-6)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 - Sunday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 - Monday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 - Tuesday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 - Wednesday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 - Thursday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 - Friday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6 - Saturday."},"children":[]}]}]}]}],"example":"0,2,5"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"interval\": \"month\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Month interval type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Repeat on same day of month. For example on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every 5th of the month,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Repeat on the same occurrence of nth day of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"week. For example on 2nd Saturday of the month."},"children":[]}]}]}]}],"enum":["day_of_month","day_of_week"],"default":"day_of_month"}}},"end_on":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When should the repeating of recurring maintenance event stop."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If not set, recurring schedule will continue. ISO8601 formatted time (UTC)"},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}},"event_notifications":{"type":"array","description":"Describes additional notifications to be sent at specific offset from maintenance start or end.\n","items":{"type":"object","properties":{"offset_in_min":{"type":"integer","description":"Negative value of offset in minutes.\n","maximum":0,"example":-60,"enum":[-129600,-86400,-43200,-10080,-2880,-1440,-120,-60,-30,-15,-5,0]},"offset_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EventNotification delivery offset type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance start time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance end time."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}],"default":"start","enum":["start","end"]}}}},"service_statuses":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":61},"service_id":{"type":"integer","minimum":1,"x-autoid":true,"example":62},"service_name":{"type":"string"},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":63},"group_name":{"type":"string"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean"},"archived":{"type":"boolean"}}}}}},"start_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event start."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"end_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event end."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Maintenance a draft - meaning, it wasn't published on a Hub Page.\n"}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services have been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Maintenance a draft - meaning, it wasn't published on a Hub Page.\n"},"published":{"type":"boolean","description":"Was this Maintenance event published on a Hub Page.\n"},"suppress_events":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the duration of maintenance all Incidents and Incident Updates created through automation (API, integrations) will not be published."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Depending on configuration such Incidents will be either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"saved as draft,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ignored."},"children":[]}]}]}]}]},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is it a silent Maintenance."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Silent events do not result in notifications being sent to subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}]},"recurring_placeholder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring maintenance schedule utilize so called Placeholder Events that are visible on Hub Page and contains all of the info as normal Maintenance events would."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" However those placeholders are not fully fledged Maintenance events and some operations may not be available for those placeholder events. For example, such events when deleted are permanently removed and are not a subject to undelete."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Placeholder events are converted to normal (full) Maintenance events when either maintenance will start soon or notifications needs to be send for this event. After converting Placeholder Maintenance to normal Maintenance, such event behaves like any other normal Maintenance event."},"children":[]}]}]}]}}}]},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","enum":["created_at","start_time","updated_at","end_time"],"default":"start_time"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","enum":["asc","desc"]},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":[],"properties":{"current_page":{"type":"integer","minimum":1,"example":1},"page_count":{"type":"integer","minimum":1,"example":4},"per_page":{"type":"integer","minimum":1,"maximum":100,"example":25},"total":{"type":"integer","minimum":0,"example":1024}}},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"string"},"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text. HTML tags and other forms of formatting are not allowed."},"children":[]}]}]}],"example":"Title of the event"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event start."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"end_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event end."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Maintenance a draft - meaning, it wasn't published on a Hub Page.\n"}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event was archived for example because all affected services have been deleted or archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Archived events are read-only."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":"Event has been deleted."},"draft":{"type":"boolean","description":"Is this Maintenance a draft - meaning, it wasn't published on a Hub Page.\n"},"published":{"type":"boolean","description":"Was this Maintenance event published on a Hub Page.\n"},"suppress_events":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the duration of maintenance all Incidents and Incident Updates created through automation (API, integrations) will not be published."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Depending on configuration such Incidents will be either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"saved as draft,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ignored."},"children":[]}]}]}]}]},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is it a silent Maintenance."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Silent events do not result in notifications being sent to subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}]},"recurring_placeholder":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring maintenance schedule utilize so called Placeholder Events that are visible on Hub Page and contains all of the info as normal Maintenance events would."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" However those placeholders are not fully fledged Maintenance events and some operations may not be available for those placeholder events. For example, such events when deleted are permanently removed and are not a subject to undelete."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Placeholder events are converted to normal (full) Maintenance events when either maintenance will start soon or notifications needs to be send for this event. After converting Placeholder Maintenance to normal Maintenance, such event behaves like any other normal Maintenance event."},"children":[]}]}]}]}}}]}}},"maxItems":100}}}]},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"allOf":[{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can contain only plain text. HTML tags and other forms of formatting are not allowed."},"children":[]}]}]}],"example":"Title of the event"},"start_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event start."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"end_time":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of event end."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"service_statuses":{"type":"array","description":"Describes affected services and their statuses.\n","items":{"type":"object","additionalProperties":false,"properties":{"service_id":{"type":"integer","example":1234},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"}}}},"body":{"type":"string","default":"","example":"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"},"silent":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notifications are not being sent to subscribers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Does not impact draft notifications for Team Members."},"children":[]}]}]}],"default":false},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Maintenance event:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Not published on Hub Page."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Draft will result in draft notifications being sent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to Team Members,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"published"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Published on Hub Page."},"children":[]}]}]}]}],"default":"published","nullable":true,"enum":["draft","published"]},"suppress_events":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the duration of maintenance all Incidents and Incident Updates created through automation (API, integrations) will not be published."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Depending on configuration such Incidents will be either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"saved as draft,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ignored."},"children":[]}]}]}]}]},"event_repeat":{"type":"object","nullable":true,"description":"Describes recurring maintenance schedules.\n","properties":{"interval":{"type":"string","description":"How frequent should the event be repeated.\n","enum":["day","week","two_weeks","month","year"]},"interval_options":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional configuration for some of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled_days"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"enabled_days":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"interval\": \"day\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of enabled days indexes (0-6)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 - Sunday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 - Monday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 - Tuesday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 - Wednesday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 - Thursday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 - Friday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6 - Saturday."},"children":[]}]}]}]}],"example":"0,2,5"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"interval\": \"month\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Month interval type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Repeat on same day of month. For example on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every 5th of the month,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day_of_week"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Repeat on the same occurrence of nth day of the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"week. For example on 2nd Saturday of the month."},"children":[]}]}]}]}],"enum":["day_of_month","day_of_week"],"default":"day_of_month"}}},"end_on":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When should the repeating of recurring maintenance event stop."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If not set, recurring schedule will continue. ISO8601 formatted time (UTC)"},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}},"event_notifications":{"type":"array","description":"Describes additional notifications to be sent at specific offset from maintenance start or end.\n","items":{"type":"object","properties":{"offset_in_min":{"type":"integer","description":"Negative value of offset in minutes.\n","maximum":0,"example":-60,"enum":[-129600,-86400,-43200,-10080,-2880,-1440,-120,-60,-30,-15,-5,0]},"offset_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EventNotification delivery offset type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance start time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - from maintenance end time."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}],"default":"start","enum":["start","end"]}}}},"recurring":{"type":"object","description":"Used only for Maintenance events being a part of Recurring Maintenance Schedule. Instructs API how to handle edit of an event that is repeating.\n","additionalProperties":false,"properties":{"update_following":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" modifies currently updated event as well as all following events being a part of the same Recurring Maintenance Schedule."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" modifies only currently updated event. Following events in same Recurring Maintenance Schedule remains unchanged."},"children":[]}]}]}]}}}}},{"type":"object","additionalProperties":false,"properties":{"recurring":{"type":"object","required":["update_following"],"additionalProperties":false,"properties":{"update_following":{"type":"boolean"}}}}}]},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":38},"title":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"labels":{"type":"array","items":{"type":"string"},"description":"List of labels for this template."},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this template deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deleted templates can't be used when creating or updating events."},"children":[]}]}]}]},"silent":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value when applying the template:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Do not set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}]}}},"incident_type":{"type":"string","nullable":true,"enum":["investigating","identified","monitoring","resolved"]},"body":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"author":{"type":"string","nullable":true,"description":"Author email"},"service_statuses":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":61},"service_id":{"type":"integer","minimum":1,"x-autoid":true,"example":62},"service_name":{"type":"string"},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":63},"group_name":{"type":"string"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean"},"archived":{"type":"boolean"}}}}}}}},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"string","enum":["created_at"],"default":"created_at"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":[],"properties":{"current_page":{"type":"integer","minimum":1,"example":1},"page_count":{"type":"integer","minimum":1,"example":4},"per_page":{"type":"integer","minimum":1,"maximum":100,"example":25},"total":{"type":"integer","minimum":0,"example":1024}}},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":29},"title":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"labels":{"type":"array","items":{"type":"string"},"description":"List of labels for this template."},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this template deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deleted templates can't be used when creating or updating events."},"children":[]}]}]}]},"silent":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value when applying the template:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Do not set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}]}}},"incident_type":{"type":"string","nullable":true,"enum":["investigating","identified","monitoring","resolved"]}}}}}}]},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":60},"title":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"labels":{"type":"array","items":{"type":"string"},"description":"List of labels for this template."},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this template deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deleted templates can't be used when creating or updating events."},"children":[]}]}]}]},"silent":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value when applying the template:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Do not set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}]}}},"duration":{"type":"integer","nullable":true,"minimum":1,"maximum":5999,"description":"Duration of maintenance in minutes.\n"},"body":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"author":{"type":"string","nullable":true,"description":"Author email"},"service_statuses":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":61},"service_id":{"type":"integer","minimum":1,"x-autoid":true,"example":62},"service_name":{"type":"string"},"status":{"type":"string","enum":["up","degraded-performance","down"],"example":"down"},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":63},"group_name":{"type":"string"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean"},"archived":{"type":"boolean"}}}}}}}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":[],"properties":{"current_page":{"type":"integer","minimum":1,"example":1},"page_count":{"type":"integer","minimum":1,"example":4},"per_page":{"type":"integer","minimum":1,"maximum":100,"example":25},"total":{"type":"integer","minimum":0,"example":1024}}},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":51},"title":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title of event."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Templates without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set will ignore event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when applied."},"children":[]}]}]}]},"labels":{"type":"array","items":{"type":"string"},"description":"List of labels for this template."},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this template deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Deleted templates can't be used when creating or updating events."},"children":[]}]}]}]},"silent":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter value when applying the template:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Do not set event "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}]}}},"duration":{"type":"integer","nullable":true,"minimum":1,"maximum":5999,"description":"Duration of maintenance in minutes.\n"}}}}}}]},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"active":{"type":"boolean"},"title":{"type":"string"},"body":{"type":"string"},"silent":{"type":"boolean","description":"Send notification to subscribers"}}},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"string","enum":["primary","connected"],"default":"primary"},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"string","enum":["position","created_at","start_time"],"default":"position"},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"string","enum":["asc","desc"],"default":"asc"},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"string","enum":["true","false"]},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":[],"properties":{"current_page":{"type":"integer","minimum":1,"example":1},"page_count":{"type":"integer","minimum":1,"example":4},"per_page":{"type":"integer","minimum":1,"maximum":100,"example":25},"total":{"type":"integer","minimum":0,"example":1024}}},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":1},"name":{"type":"string","description":"Name of the Hub.","example":"Example Hub"},"subdomain":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain serves two purposes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In various places it is being used as Hub unique identifier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in place of less descriptive numerical ID,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forms Hub URL which without custom domain in place has a form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{{subdomain}}.statushub.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"company-status"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Independent Hub without any overlap with other Hubs data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated with billing subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can have Connected Hubs if its subscription allows it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connected Hub - Hub that shares following aspects with its Primary Hub:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Groups,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events affecting the shared Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other data like Subscriptions and settings is independent."},"children":[]}]}]}]}]}],"example":"primary","enum":["primary","connected"]}}}}}}]},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":3},"name":{"type":"string"},"subdomain":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain serves two purposes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In various places it is being used as Hub unique identifier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in place of less descriptive numerical ID,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forms Hub URL which without custom domain in place has a form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{{subdomain}}.statushub.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"company-status"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Independent Hub without any overlap with other Hubs data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated with billing subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can have Connected Hubs if its subscription allows it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connected Hub - Hub that shares following aspects with its Primary Hub:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Groups,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events affecting the shared Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other data like Subscriptions and settings is independent."},"children":[]}]}]}]}]}],"example":"primary","enum":["primary","connected"]},"custom_domain":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative domain name under which the Hub can be accessed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently this field can be set only through a support ticket because of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the additional steps required like setting up the TLS certificate."},"children":[]}]}]}],"example":"status.example-company.com"},"parent_id":{"nullable":true,"type":"integer","minimum":1,"maximum":9999,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only for Connected Hubs. For Primary Hubs this field is absent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the numerical ID of Primary Hub for current Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},"product_url":{"type":"string","nullable":true,"description":"URL of the product or service for which current Hub is set-up for.\nAlternatively called \"Monitored site URL\" in Hub Main Settings in\nStatusHub Control Panel.\n\nUsed as a link target for Hub name or Logo in Hub Page top-bar.\n","example":"https://www.example-company.com/service"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":[],"properties":{"current_page":{"type":"integer","minimum":1,"example":1},"page_count":{"type":"integer","minimum":1,"example":4},"per_page":{"type":"integer","minimum":1,"maximum":100,"example":25},"total":{"type":"integer","minimum":0,"example":1024}}},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":8},"name":{"type":"string","description":"Name of the Hub.","example":"Example Hub"},"subdomain":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain serves two purposes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In various places it is being used as Hub unique identifier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in place of less descriptive numerical ID,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forms Hub URL which without custom domain in place has a form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{{subdomain}}.statushub.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"company-status"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Independent Hub without any overlap with other Hubs data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated with billing subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can have Connected Hubs if its subscription allows it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connected Hub - Hub that shares following aspects with its Primary Hub:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Groups,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events affecting the shared Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other data like Subscriptions and settings is independent."},"children":[]}]}]}]}]}],"example":"primary","enum":["primary","connected"]},"parent_id":{"type":"integer","minimum":1,"maximum":9999,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the numerical ID of Primary Hub for current Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}}}}}}]},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":12},"name":{"type":"string"},"subdomain":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub subdomain serves two purposes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In various places it is being used as Hub unique identifier"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in place of less descriptive numerical ID,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forms Hub URL which without custom domain in place has a form"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{{subdomain}}.statushub.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"company-status"},"custom_domain":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative domain name under which the Hub can be accessed."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently this field can be set only through a support ticket because of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the additional steps required like setting up the TLS certificate."},"children":[]}]}]}],"example":"status.example-company.com"},"parent_id":{"nullable":true,"type":"integer","minimum":1,"maximum":9999,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only for Connected Hubs. For Primary Hubs this field is absent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains the numerical ID of Primary Hub for current Connected Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},"product_url":{"type":"string","nullable":true,"description":"URL of the product or service for which current Hub is set-up for.\nAlternatively called \"Monitored site URL\" in Hub Main Settings in\nStatusHub Control Panel.\n\nUsed as a link target for Hub name or Logo in Hub Page top-bar.\n","example":"https://www.example-company.com/service"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hub type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Primary Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Independent Hub without any overlap with other Hubs data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated with billing subscription,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can have Connected Hubs if its subscription allows it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connected Hub - Hub that shares following aspects with its Primary Hub:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Groups,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subset of Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events affecting the shared Services,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All other data like Subscriptions and settings is independent."},"children":[]}]}]}]}]}],"example":"primary","enum":["primary","connected"]},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"description":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional description than can be visible on Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" May contain basic HTML tags."},"children":[]}]}]}]},"favicon_url":{"description":"URL of Hub favicon image.","type":"string","format":"uri","nullable":true},"logo_url":{"description":"URL of Hub logo image.","type":"string","format":"uri","nullable":true},"navbar_item":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows to add button with link to Hub Page navbar."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Both label and URL are mandatory if any of those fields contains value."},"children":[]}]}]}],"additionalProperties":false,"properties":{"label":{"type":"string","nullable":true,"example":"Support portal"},"url":{"example":"https://help.example-company.com","type":"string","format":"uri","nullable":true}}},"status_names":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom labels used on Hub Page legend section."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Can be used to change default values to better match Hub Page use-case."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For example if Hub Page is set to show availability of meeting rooms then 'down' may mean 'Room is not available' and 'degraded-performance' may mean 'Room is booked'."},"children":[]}]}]}],"properties":{"up":{"type":"string","default":"Service is operating normally"},"degraded-performance":{"type":"string","default":"Performance issues"},"down":{"type":"string","default":"Service disruption"}}},"localization":{"type":"object","additionalProperties":false,"required":[],"properties":{"iso_week":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use ISO week numbering system:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true - week starts on Monday,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false - week starts on Sunday."},"children":[]}]}]}]}]},"date_format":{"type":"string","enum":["EU","US"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used date format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EU - dd/mm/yyyy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US - mm/dd/yyyy"},"children":[]}]}]}]}]},"time_format":{"type":"string","enum":["12h","24h"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used time format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12h - hh:mm AM/PM,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"24h - HH:mm."},"children":[]}]}]}]}]},"time_zone_name":{"type":"string","description":"Default time zone used for Hub Page for visitors who haven't chosen different time zone.\n"}}},"layout":{"type":"object","additionalProperties":false,"required":[],"properties":{"view_type":{"type":"string","enum":["list","calendar","no_history","connected_hubs_grid"],"description":"History view type\n"},"background_color":{"nullable":true,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom background color in Hex format."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For Hubs still using background image, setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"background_color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will remove the background image which can then only be added through a support request."},"children":[]}]}]}],"example":"#ffffff"},"platform_alerts":{"type":"boolean","description":"Show platform alerts on this Hub Page"},"hubs_switcher":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show Hubs switcher on this Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This setting controls if the Hub Switcher is visible on current Hub Page."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In order to choose which Hubs are visible in Hub Switcher "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"show_in_hubs_switcher"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be used on respective Hubs."},"children":[]}]}]}]},"show_in_hubs_switcher":{"type":"boolean","description":"Show this Hub inside Hubs Switcher in Hubs that show the Hubs Switcher in current account.\n"},"uptime_chart":{"type":"boolean","description":"Shows uptime chart on hits Hub Page."},"whitelabel":{"type":"boolean","description":"Hide default \"Powered by StatusHub\" footer.\n"},"background_image_url":{"type":"string","format":"uri","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL of image used as Hub background image."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This is a read-only field and is a legacy feature."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"background_color"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set, it's not possible to set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"background_image"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" nor "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"background_image_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" again in API nor in StatusHub Control Panel. Only way to set the background image is through a support request."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is not returned when background image is not being used."},"children":[]}]}]}]}}}}},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"allowed_methods":{"type":"array","items":{"type":"string","enum":["saml","google_oauth","global_password","public"]},"example":["saml","google_oauth","global_password","public"]},"enabled_method":{"type":"string","enum":["saml","google_oauth","global_password","public"]}}},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"enabled":{"type":"boolean"},"idp_metadata":{"type":"string","nullable":true,"description":"IdP SAML metadata in XML format.\n","example":"<?xml version=\"1.0\"?>\n<md:EntityDescriptor\n  xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\"\n  entityID=\"https://some-idp.company.com/\"\n>\n...\n</md:EntityDescriptor>\n"},"debug":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls verbosity of SAML error page:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Show detailed error message,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Show generic error message without details."},"children":[]}]}]}]}]},"sign_out_target":{"type":"string","format":"uri","nullable":true,"description":"Location where user will be redirected after successful sign-out.\n"},"slo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls if SLO should be used when signing-out from Hub:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - SLO is enabled. This requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SingleLogoutService"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration to be included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idp_metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - SLO is not enabled."},"children":[]}]}]}]}]},"sp_data":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informational field."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns identifiers and URL that can be used to setup SAML connection."},"children":[]}]}]}],"required":[],"properties":{"certificate_url":{"description":"URL from which StatusHub SAML public certificate can be downloaded\nfrom.\n","type":"string","format":"uri"},"metadata_url":{"description":"URL from which StatusHub SP metadata in XML format can be downloaded\nfrom.\n","type":"string","format":"uri"},"entity_id":{"description":"SP Entity ID.","type":"string","format":"uri"},"sso_url":{"description":"Sign-on URL.","type":"string","format":"uri"},"slo_url":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sign-out URL. Works only if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled."},"children":[]}]}]}],"type":"string","format":"uri"}}}}},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of Google OAuth authorization."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In order to enable this method the domains whitelist has to be set and enabled."},"children":[]}]}]}]}}},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"enabled":{"type":"boolean"}}},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"enabled":{"type":"boolean"},"domains_whitelist":{"type":"array","items":{"type":"string","pattern":"[a-z0-9][a-z0-9_-]*[a-z0-9]\\.[a-z]{2,}"},"description":"Array of domain names.\n","example":["company.com","another-domain.com"]}}},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"enabled":{"type":"boolean"},"ip_whitelist":{"type":"array","items":{"anyOf":[{"type":"string","pattern":"([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}","description":"IP V4 address"},{"type":"string","pattern":"([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\.([1-2])?\\d{1,2}\\/[0-9]{1,2}","description":"IP V4 range in CIDR format\n"}]},"example":["54.210.121.161","144.201.96.0/21"]}}},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"string","enum":["logo","favicon"]},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"string","enum":["position","created_at","updated_at"],"default":"position"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":[],"properties":{"current_page":{"type":"integer","minimum":1,"example":1},"page_count":{"type":"integer","minimum":1,"example":4},"per_page":{"type":"integer","minimum":1,"maximum":100,"example":25},"total":{"type":"integer","minimum":0,"example":1024}}},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":100},"name":{"type":"string"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this group archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the services in archived group are still visible on Hub Page with direct event link."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this group deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the services in deleted group are not visible on Hub Page, even with direct event link."},"children":[]}]}]}]}}}}}}}}]},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":101},"name":{"type":"string"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this group archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the services in archived group are still visible on Hub Page with direct event link."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this group deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the services in deleted group are not visible on Hub Page, even with direct event link."},"children":[]}]}]}]}}}}},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["reference_id","position"],"properties":{"reference_id":{"type":"integer","description":"The ID of another group which position will be used as a reference to new position of reordered group.\n"},"position":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if reordered group should be put before or after reference group specified by ID in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}],"enum":["before","after"]}}},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"default":true,"type":"boolean"},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":[],"properties":{"current_page":{"type":"integer","minimum":1,"example":1},"page_count":{"type":"integer","minimum":1,"example":4},"per_page":{"type":"integer","minimum":1,"maximum":100,"example":25},"total":{"type":"integer","minimum":0,"example":1024}}},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":102},"custom_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a property that can be used to assign an external identifier to a service. This identifier can be used, for example, to synchronize monitored entities with services in StatusHub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has to be unique within the scope of a Hub."},"children":[]}]}]}],"nullable":true},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":103},"name":{"type":"string"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this service archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the archived services are still visible on Hub Page with direct event link."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this service deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the deleted services are still visible on Hub Page with direct event link."},"children":[]}]}]}]}}}}}}}}]},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"custom_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a property that can be used to assign an external identifier to a service. This identifier can be used, for example, to synchronize monitored entities with services in StatusHub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has to be unique within the scope of a Hub."},"children":[]}]}]}],"nullable":true},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to add more information describing the service on a Hub Page. Description is visible inside a tooltip in a Hub Page."},"children":[]}]}]}],"nullable":true},"group_id":{"type":"integer","minimum":1,"x-autoid":true,"example":106},"id":{"type":"integer","minimum":1,"x-autoid":true,"example":107},"name":{"type":"string"},"public_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an optional name that can be used to show different name for visitors of Hub Page and subscribers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typical use-case is to use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describing customer or contractor name so members using StatusHub Control Panel can distinguish the services easily and use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with generic or obfuscated name to not disclose the actual name of customer or subcontractor especially on public Hubs."},"children":[]}]}]}],"nullable":true},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique token value that is being used to connect external integrations to StatusHub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically all integration URLs are using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value so knowing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value allows to construct various integrations URLs programmatically."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this service archived."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the archived services are still visible on Hub Page with direct event link."},"children":[]}]}]}]},"deleted":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this service deleted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Events affecting only the deleted services are still visible on Hub Page with direct event link."},"children":[]}]}]}]}}}}},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["reference_id","position"],"properties":{"reference_id":{"type":"integer","description":"The ID of another service which position will be used as a reference to new position of reordered service.\n"},"position":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies if reordered service should be put before or after reference service specified by ID in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}],"enum":["before","after"]}}},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"string","enum":["v1","v2"]},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":[],"properties":{"current_page":{"type":"integer","minimum":1,"example":1},"page_count":{"type":"integer","minimum":1,"example":4},"per_page":{"type":"integer","minimum":1,"maximum":100,"example":25},"total":{"type":"integer","minimum":0,"example":1024}}},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"enabled":{"type":"boolean","description":"Is integration enabled on this service\n","example":true},"slug":{"type":"string","enum":["generic_hook","generic_hook_v2","ilert","isdownapp","new_relic","opsgenie","pager_duty","pingdom","site_247","statusgator","still_alive","uptime_robot","uptrends","victor_ops"],"example":"generic_hook_v2"},"version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the integration."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently available versions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - basic integrations available in StatusHub for long time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - more capable integrations. All newly introduced"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations will be added in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" version."},"children":[]}]}]}]}],"enum":["v1","v2"],"example":"v2"}}}}}}]},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"string","enum":["generic_hook","generic_hook_v2","ilert","isdownapp","new_relic","opsgenie","pager_duty","pingdom","site_247","statusgator","still_alive","uptime_robot","uptrends","victor_ops"]},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"enabled":{"type":"boolean","description":"Is integration enabled on this service\n","example":true},"slug":{"type":"string","enum":["generic_hook","generic_hook_v2","ilert","isdownapp","new_relic","opsgenie","pager_duty","pingdom","site_247","statusgator","still_alive","uptime_robot","uptrends","victor_ops"],"example":"generic_hook_v2"},"version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the integration."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently available versions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - basic integrations available in StatusHub for long time,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - more capable integrations. All newly introduced"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations will be added in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" version."},"children":[]}]}]}]}],"enum":["v1","v2"],"example":"v2"},"url":{"type":"string","format":"uri","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Except for Pingdom integration, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is unique per-Service URL that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should be used to connect 3rd party service to StatusHub Service."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior of this field varies between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations, this URL share same token part between"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integrations and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is never blank,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations, each integration may use different token."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is blank if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integration is not enabled."},"children":[]}]}]}]}],"example":"https://app.statushub.io/hooks/generic_hook_v2?token=a18331da-19a5-46f1-8bfa-06a6a31f1d10"}}},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of app:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will work for as long as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used token is valid,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will not work even if used token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is valid."},"children":[]}]}]}]}],"example":true},"slug":{"type":"string","description":"External Application slug","example":"widget"}}}},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"string","enum":["minimal_widget","widget","zendesk","statusapi"]},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of app:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will work for as long as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used token is valid,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will not work even if used token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is valid."},"children":[]}]}]}]}],"example":true},"slug":{"type":"string","description":"External Application slug","example":"widget"}}},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"oneOf":[{"type":"object","description":"Returned for all External Apps except for Status API.\n","additionalProperties":false,"required":[],"properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of app:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will work for as long as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used token is valid,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will not work even if used token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is valid."},"children":[]}]}]}]}],"example":true},"slug":{"type":"string","description":"External Application slug","example":"widget"},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token used when installing StatusHub application/widget."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one token is valid at a time."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to rotate for example compromised token reset token operation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can be used."},"children":[]}]}]}],"example":"0bf65c9c5aca1133e906abf80f02fd9f8066aa94"}}},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned for Status API which has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_secret"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of app:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will work for as long as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used token is valid,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Application installations will not work even if used token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is valid."},"children":[]}]}]}]}],"example":true},"slug":{"type":"string","description":"External Application slug","example":"widget"},"client_id":{"type":"string","description":"Client ID used for Status API application authentication","example":"87b4c329f0075aa5958682785bed5c37009758de"},"client_secret":{"type":"string","description":"Client Secret used for Status API application authentication","example":"ba83af8c4913b4c150c0945f93cbb3377611ce41"}}}]},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"uptime":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uptime value for the requested period. Value is between 0.0 and 1.0, where 0 means no uptime and 1 means 100% uptime."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Uptime value is always rounded down."},"children":[]}]}]}],"minimum":0,"maximum":1,"example":0.9995}}},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":86},"address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address for a subscription. Exact meaning depends on method name:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email - email address,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sms - phone number,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook - URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"slack - Slack Incoming Webhook URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"teams - MS Teams Incoming Webhook URL."},"children":[]}]}]}]}],"example":"example@statushub.com"},"configuration":{"type":"object","additionalProperties":false,"description":"Additional configuration for this method name or this Subscription\n","properties":{"short_messages":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for Slack subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values explanation:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this subscription will receive regular notification payload,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - this subscription will receive smaller version"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of notifications with less data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example affected services list will not be included."},"children":[]}]}]}]}],"default":false},"content_type":{"type":"string","enum":["application/x-www-form-urlencoded","application/json"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid only for webhook subscriptions."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies what content type will be used to encode"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"notification payload."},"children":[]}]}]}],"default":"application/x-www-form-urlencoded"}},"example":{"content_type":"application/json"}},"method_name":{"type":"string","enum":["email","sms","webhook","slack","teams"],"example":"email"},"subscriber_id":{"type":"integer","minimum":1,"x-autoid":true,"example":87},"services_selection":{"type":"object","additionalProperties":false,"required":[],"properties":{"all":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this subscription subscribed to all services in the Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Subscription subscribed to all services will be notified about events affecting the services even if service was added after the subscription has been created."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If subscription is not subscribed to all services then any notification affecting only newly added service will not be sent to this subscription."},"children":[]}]}]}],"example":true},"services":{"type":"array","nullable":true,"items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","example":1234},"name":{"type":"string","example":"Service name"},"group_name":{"type":"string","example":"Group name"},"archived":{"type":"boolean","example":false}}}}}},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Subscription has been deleted.","example":false}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Subscription has been deleted.","example":false},"less_verbose":{"type":"boolean","description":"Subscription will receive the minimum number of notifications per incident - typically first and final.\n","default":false,"example":true},"credentials":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription use additional credentials in request headers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid only for webhook subscriptions."},"children":[]}]}]}],"example":false},"protected":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription is protected which means it doesn't have the ability of self-service like editing the services list or subscription options as well as doesn't have the ability to self-unsubscribe."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used for group email subscriptions where without this option, any member of an email group could use unsubscribe through the unsubscribe link sent in every notification. And as a result the whole group would stop receiving notifications."},"children":[]}]}]}],"default":false,"example":false}}}]},"label":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information to add better meaning for subscription."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used to add responsible person name or team to SMS or URL-based subscriptions where address alone is not enough to know who is receiving the notifications."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Not available for email subscriptions."},"children":[]}]}]}],"example":"Responsible person name"},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2020-09-01T08:29:00Z"},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"string","enum":["created_at","updated_at"],"default":"created_at"},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":[],"properties":{"current_page":{"type":"integer","minimum":1,"example":1},"page_count":{"type":"integer","minimum":1,"example":4},"per_page":{"type":"integer","minimum":1,"maximum":100,"example":25},"total":{"type":"integer","minimum":0,"example":1024}}},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":78},"address":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Address for a subscription. Exact meaning depends on method name:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email - email address,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sms - phone number,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook - URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"slack - Slack Incoming Webhook URL,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"teams - MS Teams Incoming Webhook URL."},"children":[]}]}]}]}],"example":"example@statushub.com"},"method_name":{"type":"string","enum":["email","sms","webhook","slack","teams"],"example":"email"},"subscriber_id":{"type":"integer","minimum":1,"x-autoid":true,"example":79},"label":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information to add better meaning for subscription."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used to add responsible person name or team to SMS or URL-based subscriptions where address alone is not enough to know who is receiving the notifications."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Not available for email subscriptions."},"children":[]}]}]}],"example":"Responsible person name"},"services_selection":{"type":"object","additionalProperties":false,"required":[],"properties":{"all":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is this subscription subscribed to all services in the Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Subscription subscribed to all services will be notified about events affecting the services even if service was added after the subscription has been created."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If subscription is not subscribed to all services then any notification affecting only newly added service will not be sent to this subscription."},"children":[]}]}]}],"example":true}}},"flags":{"oneOf":[{"type":"object","title":"Basic flags","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Subscription has been deleted.","example":false}}},{"type":"object","title":"Extended flags","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend=flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in request query params."},"children":[]}]}]}],"additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Subscription has been deleted.","example":false},"less_verbose":{"type":"boolean","description":"Subscription will receive the minimum number of notifications per incident - typically first and final.\n","default":false,"example":true},"credentials":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription use additional credentials in request headers."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Valid only for webhook subscriptions."},"children":[]}]}]}],"example":false},"protected":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription is protected which means it doesn't have the ability of self-service like editing the services list or subscription options as well as doesn't have the ability to self-unsubscribe."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Typically used for group email subscriptions where without this option, any member of an email group could use unsubscribe through the unsubscribe link sent in every notification. And as a result the whole group would stop receiving notifications."},"children":[]}]}]}],"default":false,"example":false}}}]}}},"maxItems":100}}}]},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":67},"idp_id":{"type":"string","description":"Identifier used to authenticate the subscriber for private Hubs that use authorization method providing user ID. For example for SAML protected Hubs.\n","nullable":true,"example":"internal-identifier-at-company.com"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Subscriber has been deleted.","example":false}}},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of record creation."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of last modification of record."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ISO8601 formatted time (UTC)."},"children":[]}]}]}],"example":"2020-09-01T08:29:00Z"}}},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"string","example":"internal-identifier-at-company.com"},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"allOf":[{"type":"object","required":[],"properties":{"current_page":{"type":"integer","minimum":1,"example":1},"page_count":{"type":"integer","minimum":1,"example":4},"per_page":{"type":"integer","minimum":1,"maximum":100,"example":25},"total":{"type":"integer","minimum":0,"example":1024}}},{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":[],"properties":{"id":{"type":"integer","minimum":1,"x-autoid":true,"example":64},"idp_id":{"type":"string","description":"Identifier used to authenticate the subscriber for private Hubs that use authorization method providing user ID. For example for SAML protected Hubs.\n","nullable":true,"example":"internal-identifier-at-company.com"},"flags":{"type":"object","additionalProperties":false,"required":[],"properties":{"deleted":{"type":"boolean","description":"Subscriber has been deleted.","example":false}}}}},"maxItems":100}}}]},"id":"schema_68"}},"exampleStore":{"components/examples/InvalidAPIKey":{"id":"components/examples/InvalidAPIKey","value":{"message":["user_unauthorized"]},"description":"Returned when API key is invalid.\n"},"components/examples/InsufficientAPIKeyRole":{"id":"components/examples/InsufficientAPIKeyRole","value":{"message":"not authorized"},"description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n"},"components/examples/InvalidSubdomain":{"id":"components/examples/InvalidSubdomain","value":{"message":"record not found"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}]},"components/examples/MalformedJSON":{"id":"components/examples/MalformedJSON","value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"description":"Returned when payload is not a valid JSON content.\n"},"components/examples/RecordNotFound":{"id":"components/examples/RecordNotFound","value":{"message":"record not found"},"description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n"},"components/examples/InvalidProductURLFormat":{"id":"components/examples/InvalidProductURLFormat","value":{"product_url":["invalid format"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not have a valid URL format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example when it doesn't have protocol ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") specified."},"children":[]}]}]}]},"components/examples/InvalidHubTypePH":{"id":"components/examples/InvalidHubTypePH","value":{"message":["hub must be primary"]},"description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n"},"components/examples/hub_responses_InvalidSubdomain":{"id":"components/examples/hub_responses_InvalidSubdomain","value":{"subdomain":["already taken","not allowed"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid or not available."},"children":[]}]}]}]},"components/examples/QuotaReached":{"id":"components/examples/QuotaReached","value":{"connected_hub":["limit reached"]},"description":"Returned when the Connected Hubs quota for current Primary\nHub has been reached or Connected Hubs are not available\nfor current Primary Hub plan.\n"},"components/examples/OK":{"id":"components/examples/OK","value":{"message":"OK"},"description":"Operation was successful."},"components/examples/InvalidDeletedParam":{"id":"components/examples/InvalidDeletedParam","value":{"deleted":["must be one of: true, false, all"]},"description":"Returned when deleted param is invalid.\n"},"components/examples/InvalidExtendParam":{"id":"components/examples/InvalidExtendParam","value":{"extend[0]":["must be one of: flags"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains property that does not exist or not support extending."},"children":[]}]}]}]},"components/examples/CreateBasicExample":{"id":"components/examples/CreateBasicExample","value":{"title":"Example incident title","start_time":"2025-05-02 12:34:56","incident_type":"investigating","body":"Incident body<br>with basic HTML tags.","service_statuses":[{"service_id":17363,"status":"degraded-performance"},{"service_id":17155,"status":"down"}]},"description":"Basic example of creating incident affecting two services.\n"},"components/examples/CreateSilentDraft":{"id":"components/examples/CreateSilentDraft","value":{"title":"Example incident title - silent + draft","start_time":"2025-05-02 12:34:56","incident_type":"investigating","body":"Incident body<br>with basic HTML tags.","service_statuses":[{"service_id":17363,"status":"degraded-performance"},{"service_id":17155,"status":"down"}],"silent":true,"state":"draft"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example of creating silent incident draft."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" affects notification to subscribers and does not affect nor suppress draft notifications to team members."},"children":[]}]}]}]},"components/examples/MissingRequiredValues":{"id":"components/examples/MissingRequiredValues","value":{"title":["is missing"],"start_time":["is missing"],"incident_type":["is missing"]},"description":"Returned when payload is missing values for mandatory fields.\n"},"components/examples/StartTimeInFuture":{"id":"components/examples/StartTimeInFuture","value":{"start_time":["cannot_be_in_future"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set in future. Incidents unlike Maintenance events, can't be created in future."},"children":[]}]}]}]},"components/examples/WrongServiceIDs":{"id":"components/examples/WrongServiceIDs","value":{"service_statuses":["wrong_hub"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't match any service in currently used Hub. Same error is returned when there is no service with such ID as well as when service with such ID exists but in different Hub."},"children":[]}]}]}]},"components/examples/Requests-CreateBasicExample":{"id":"components/examples/Requests-CreateBasicExample","value":{"title":"Example incident title","start_time":"2025-05-02 12:34:56","incident_type":"investigating","body":"Incident body<br>with basic HTML tags.","service_statuses":[{"service_id":17363,"status":"degraded-performance"},{"service_id":17155,"status":"down"}]},"description":"Basic example of creating incident update affecting two services.\n"},"components/examples/CreateResolving":{"id":"components/examples/CreateResolving","value":{"title":"Example incident title","start_time":"2025-05-02 12:34:56","incident_type":"resolved","body":"Final message<br>with basic HTML tags."},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resolving incident by creating incident update with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"incident_type\": \"resolved\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"components/examples/UpdateAlterBody":{"id":"components/examples/UpdateAlterBody","value":{"body":"New incident update message."},"description":"Change incident update message.\n"},"components/examples/UpdatePublishDraft":{"id":"components/examples/UpdatePublishDraft","value":{"state":"published"},"description":"Publish incident update which was created as draft.\n"},"components/examples/templates_responses_MissingRequiredValues":{"id":"components/examples/templates_responses_MissingRequiredValues","value":{"template":["must_have_title_or_body"]},"description":"Returned when payload is missing values for mandatory fields.\n"},"components/examples/InvalidServiceIDs":{"id":"components/examples/InvalidServiceIDs","value":{"service_statuses":["not all services belong to the hub"]},"description":"Returned when some of service IDs are invalid or does not belong to current Hub.\n"},"components/examples/maintenances_Requests-CreateBasicExample":{"id":"components/examples/maintenances_Requests-CreateBasicExample","value":{"title":"Example maintenance title","start_time":"2025-05-02 12:34:56","end_time":"2025-05-02 13:34:56","body":"Maintenance body<br>with basic HTML tags.","service_statuses":[{"service_id":17363,"status":"degraded-performance"},{"service_id":17155,"status":"down"}]},"description":"Basic example of creating maintenance affecting two services.\n"},"components/examples/CreateMonthlyRecurring":{"id":"components/examples/CreateMonthlyRecurring","value":{"title":"Example maintenance title","start_time":"2025-05-02 12:34:56","end_time":"2025-05-02 13:34:56","body":"Maintenance body<br>with basic HTML tags.","service_statuses":[{"service_id":17363,"status":"degraded-performance"},{"service_id":17155,"status":"down"}],"event_repeat":{"interval":"month"}},"description":"Example of creating recurring maintenance that should repeat every month.\n"},"components/examples/maintenance_responses_MissingRequiredValues":{"id":"components/examples/maintenance_responses_MissingRequiredValues","value":{"title":["is missing"],"start_time":["is missing"],"end_time":["is missing"]},"description":"Returned when payload is missing values for mandatory fields.\n"},"components/examples/AlreadySubscribed":{"id":"components/examples/AlreadySubscribed","value":{"subscriptions[0].address":["already subscribed","already taken"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when address is already subscribed to current Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions[0]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to first subscription passed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of request body."},"children":[]}]}]}]},"components/examples/DuplicatedMethod":{"id":"components/examples/DuplicatedMethod","value":{"subscriptions":["can not have multiple identical methods"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when there is more than one subscription for any method name."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions[0]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to first subscription passed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of request body."},"children":[]}]}]}]},"components/examples/InvalidAddress":{"id":"components/examples/InvalidAddress","value":{"subscriptions[2].address":["invalid"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when address of subscription is invalid for given method name."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions[2]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to first subscription passed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of request body."},"children":[]}]}]}]},"components/examples/subscriber_responses_InvalidServiceIDs":{"id":"components/examples/subscriber_responses_InvalidServiceIDs","value":{"subscriptions[1].services_selection":["invalid"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when address of subscription is invalid for given method name."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions[1]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to first subscription passed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of request body."},"children":[]}]}]}]},"components/examples/DuplicatedIDPID":{"id":"components/examples/DuplicatedIDPID","value":{"idp_id":["already taken"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idp_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has already been used in current Hub."},"children":[]}]}]}]},"components/examples/InvalidSubscriber":{"id":"components/examples/InvalidSubscriber","value":{"message":"subscriber not found"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when SubscriberID is invalid."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]},"components/examples/CreateMinimalEmail":{"id":"components/examples/CreateMinimalEmail","value":{"address":"example@statushub.com","method_name":"email","services_selection":{"all":true}},"description":"Minimal example creating email subscription.\n"},"components/examples/CreateBasicEmail":{"id":"components/examples/CreateBasicEmail","value":{"address":"example@statushub.com","method_name":"email","services_selection":{"service_ids":[17155,17363]},"less_verbose":true},"description":"Example creating email subscription with less verbose option and services selection.\n"},"components/examples/DuplicatedAddress":{"id":"components/examples/DuplicatedAddress","value":{"address":["already taken","already subscribed"]},"description":"Returned when there is more than one subscription for any method name for current Hub.\n"},"components/examples/subscription_responses_DuplicatedMethod":{"id":"components/examples/subscription_responses_DuplicatedMethod","value":{"method_name":["already subscribed"]},"description":"Returned when there is more than one subscription for any method name for current Subscriber.\n"},"components/examples/subscription_responses_InvalidAddress":{"id":"components/examples/subscription_responses_InvalidAddress","value":{"address":["invalid"]},"description":"Returned when address of subscription is invalid for given method name.\n"},"components/examples/InvalidSubscriberID":{"id":"components/examples/InvalidSubscriberID","value":{"subscriber_id":["invalid"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when SubscriberID is invalid."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned also when trying to create Subscription for deleted Subscriber."},"children":[]}]}]}]},"components/examples/MissingServicesSelection":{"id":"components/examples/MissingServicesSelection","value":{"services_selection":["is missing"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services_selection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is missing or incomplete."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example of incomplete "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services_selection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"services_selection\": {\"all\": false}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which would indicate that a subset of services should be used but the services list was not provided."},"children":[]}]}]}]},"components/examples/ForbiddenRestore":{"id":"components/examples/ForbiddenRestore","value":{"message":"not authorized"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when restoring subscription is not allowed because such subscription would violate validations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For example when attempting to restore subscription with address that is already being used by an active (not deleted) subscription in the same Hub."},"children":[]}]}]}]},"components/examples/InvalidArchivedParam":{"id":"components/examples/InvalidArchivedParam","value":{"archived":["must be one of: true, false, all"]},"description":"Returned when archived param is invalid.\n"},"components/examples/AttemptToModifyArchivedGroup":{"id":"components/examples/AttemptToModifyArchivedGroup","value":{"message":"not authorized"},"description":"Returned when trying to modify group that was archived.\n"},"components/examples/AttemptToModifyArchivedService":{"id":"components/examples/AttemptToModifyArchivedService","value":{"message":"not authorized"},"description":"Returned when trying to modify service that was archived.\n"},"components/examples/InvalidHubTypeCH":{"id":"components/examples/InvalidHubTypeCH","value":{"message":["hub must be connected"]},"description":"Returned when performing on Primary or Standalone Hub a request valid only for Connected Hub.\n"},"components/examples/InvalidEndDateParam":{"id":"components/examples/InvalidEndDateParam","value":{"end_date":["must be a date"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when date param can't be parsed as valid date."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date=2025-02-31"},"children":[]}]}]}]},"components/examples/TooFarEndDateParam":{"id":"components/examples/TooFarEndDateParam","value":{"end_date":["must be less than or equal to 2024-08-01"]},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param is too far apart from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response specifies maximum value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that can be used with provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Basic example":{"value":{"title":"Example incident title","start_time":"2025-05-02 12:34:56","incident_type":"investigating","body":"Incident body<br>with basic HTML tags.","service_statuses":[{"service_id":17363,"status":"degraded-performance"},{"service_id":17155,"status":"down"}]},"key":"Basic example","summary":"Basic example","description":"Basic example of creating incident affecting two services.\n","id":"paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Basic example"},"paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Creating an incident draft with silent option":{"value":{"title":"Example incident title - silent + draft","start_time":"2025-05-02 12:34:56","incident_type":"investigating","body":"Incident body<br>with basic HTML tags.","service_statuses":[{"service_id":17363,"status":"degraded-performance"},{"service_id":17155,"status":"down"}],"silent":true,"state":"draft"},"key":"Creating an incident draft with silent option","summary":"Creating an incident draft with silent option","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example of creating silent incident draft."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Please note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"silent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" affects notification to subscribers and does not affect nor suppress draft notifications to team members."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents/post/requestBody/content/application~1json/examples/Creating an incident draft with silent option"},"paths/~1hubs~1{subdomain}~1incidents/post/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1incidents/post/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1incidents/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incidents/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incidents/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incidents/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incidents/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Missing required values":{"value":{"title":["is missing"],"start_time":["is missing"],"incident_type":["is missing"]},"key":"Missing required values","summary":"Missing required values","description":"Returned when payload is missing values for mandatory fields.\n","id":"paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Missing required values"},"paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Start time in future":{"value":{"start_time":["cannot_be_in_future"]},"key":"Start time in future","summary":"Start time in future","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set in future. Incidents unlike Maintenance events, can't be created in future."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Start time in future"},"paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Wrong service IDs":{"value":{"service_statuses":["wrong_hub"]},"key":"Wrong service IDs","summary":"Wrong service IDs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't match any service in currently used Hub. Same error is returned when there is no service with such ID as well as when service with such ID exists but in different Hub."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents/post/responses/422/content/application~1json/examples/Wrong service IDs"},"paths/~1hubs~1{subdomain}~1incidents/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incidents/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incidents/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incidents/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incidents/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incidents/get/responses/422/content/application~1json/examples/Invalid deleted param":{"value":{"deleted":["must be one of: true, false, all"]},"key":"Invalid deleted param","summary":"Invalid deleted param","description":"Returned when deleted param is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incidents/get/responses/422/content/application~1json/examples/Invalid deleted param"},"paths/~1hubs~1{subdomain}~1incidents/get/responses/422/content/application~1json/examples/Invalid extend param":{"value":{"extend[0]":["must be one of: flags"]},"key":"Invalid extend param","summary":"Invalid extend param","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains property that does not exist or not support extending."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents/get/responses/422/content/application~1json/examples/Invalid extend param"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/404/content/application~1json/examples/Invalid incident_id":{"value":{"message":"record not found"},"key":"Invalid incident_id","summary":"Invalid incident_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/404/content/application~1json/examples/Invalid incident_id"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/422/content/application~1json/examples/Invalid extend param":{"value":{"extend[0]":["must be one of: flags"]},"key":"Invalid extend param","summary":"Invalid extend param","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains property that does not exist or not support extending."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/get/responses/422/content/application~1json/examples/Invalid extend param"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/200/content/application~1json/examples/OK":{"value":{"message":"OK"},"key":"OK","summary":"OK","description":"Operation was successful.","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/200/content/application~1json/examples/OK"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id":{"value":{"message":"record not found"},"key":"Invalid incident_id","summary":"Invalid incident_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Basic example":{"value":{"title":"Example incident title","start_time":"2025-05-02 12:34:56","incident_type":"investigating","body":"Incident body<br>with basic HTML tags.","service_statuses":[{"service_id":17363,"status":"degraded-performance"},{"service_id":17155,"status":"down"}]},"key":"Basic example","summary":"Basic example","description":"Basic example of creating incident update affecting two services.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Basic example"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Resolving incident":{"value":{"title":"Example incident title","start_time":"2025-05-02 12:34:56","incident_type":"resolved","body":"Final message<br>with basic HTML tags."},"key":"Resolving incident","summary":"Resolving incident","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resolving incident by creating incident update with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"incident_type\": \"resolved\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/requestBody/content/application~1json/examples/Resolving incident"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/404/content/application~1json/examples/Invalid incident_id":{"value":{"message":"record not found"},"key":"Invalid incident_id","summary":"Invalid incident_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/404/content/application~1json/examples/Invalid incident_id"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Missing required values":{"value":{"title":["is missing"],"start_time":["is missing"],"incident_type":["is missing"]},"key":"Missing required values","summary":"Missing required values","description":"Returned when payload is missing values for mandatory fields.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Missing required values"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Start time in future":{"value":{"start_time":["cannot_be_in_future"]},"key":"Start time in future","summary":"Start time in future","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set in future. Incidents unlike Maintenance events, can't be created in future."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Start time in future"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Wrong service IDs":{"value":{"service_statuses":["wrong_hub"]},"key":"Wrong service IDs","summary":"Wrong service IDs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't match any service in currently used Hub. Same error is returned when there is no service with such ID as well as when service with such ID exists but in different Hub."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/post/responses/422/content/application~1json/examples/Wrong service IDs"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/404/content/application~1json/examples/Invalid incident_id":{"value":{"message":"record not found"},"key":"Invalid incident_id","summary":"Invalid incident_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/404/content/application~1json/examples/Invalid incident_id"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/422/content/application~1json/examples/Invalid extend param":{"value":{"extend[0]":["must be one of: flags"]},"key":"Invalid extend param","summary":"Invalid extend param","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains property that does not exist or not support extending."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates/get/responses/422/content/application~1json/examples/Invalid extend param"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid incident_id":{"value":{"message":"record not found"},"key":"Invalid incident_id","summary":"Invalid incident_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid incident_id"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid incident_update_id":{"value":{"message":"record not found"},"key":"Invalid incident_update_id","summary":"Invalid incident_update_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/404/content/application~1json/examples/Invalid incident_update_id"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/422/content/application~1json/examples/Invalid extend param":{"value":{"extend[0]":["must be one of: flags"]},"key":"Invalid extend param","summary":"Invalid extend param","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains property that does not exist or not support extending."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/get/responses/422/content/application~1json/examples/Invalid extend param"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Update message":{"value":{"body":"New incident update message."},"key":"Update message","summary":"Update message","description":"Change incident update message.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Update message"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Publish draft":{"value":{"state":"published"},"key":"Publish draft","summary":"Publish draft","description":"Publish incident update which was created as draft.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/requestBody/content/application~1json/examples/Publish draft"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid incident_id":{"value":{"message":"record not found"},"key":"Invalid incident_id","summary":"Invalid incident_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid incident_id"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid incident_update_id":{"value":{"message":"record not found"},"key":"Invalid incident_update_id","summary":"Invalid incident_update_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/404/content/application~1json/examples/Invalid incident_update_id"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/422/content/application~1json/examples/Start time in future":{"value":{"start_time":["cannot_be_in_future"]},"key":"Start time in future","summary":"Start time in future","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set in future. Incidents unlike Maintenance events, can't be created in future."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/422/content/application~1json/examples/Start time in future"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/422/content/application~1json/examples/Wrong service IDs":{"value":{"service_statuses":["wrong_hub"]},"key":"Wrong service IDs","summary":"Wrong service IDs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't match any service in currently used Hub. Same error is returned when there is no service with such ID as well as when service with such ID exists but in different Hub."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/put/responses/422/content/application~1json/examples/Wrong service IDs"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/200/content/application~1json/examples/OK":{"value":{"message":"OK"},"key":"OK","summary":"OK","description":"Operation was successful.","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/200/content/application~1json/examples/OK"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id":{"value":{"message":"record not found"},"key":"Invalid incident_id","summary":"Invalid incident_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id"},"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid incident_update_id":{"value":{"message":"record not found"},"key":"Invalid incident_update_id","summary":"Invalid incident_update_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1incidents~1{incident_id}~1incident_updates~1{incident_update_id}/delete/responses/404/content/application~1json/examples/Invalid incident_update_id"},"paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Basic example":{"value":{"title":"Example maintenance title","start_time":"2025-05-02 12:34:56","end_time":"2025-05-02 13:34:56","body":"Maintenance body<br>with basic HTML tags.","service_statuses":[{"service_id":17363,"status":"degraded-performance"},{"service_id":17155,"status":"down"}]},"key":"Basic example","summary":"Basic example","description":"Basic example of creating maintenance affecting two services.\n","id":"paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Basic example"},"paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Creating a recurring maintenance repeating every month":{"value":{"title":"Example maintenance title","start_time":"2025-05-02 12:34:56","end_time":"2025-05-02 13:34:56","body":"Maintenance body<br>with basic HTML tags.","service_statuses":[{"service_id":17363,"status":"degraded-performance"},{"service_id":17155,"status":"down"}],"event_repeat":{"interval":"month"}},"key":"Creating a recurring maintenance repeating every month","summary":"Creating a recurring maintenance repeating every month","description":"Example of creating recurring maintenance that should repeat every month.\n","id":"paths/~1hubs~1{subdomain}~1maintenances/post/requestBody/content/application~1json/examples/Creating a recurring maintenance repeating every month"},"paths/~1hubs~1{subdomain}~1maintenances/post/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1maintenances/post/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1maintenances/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1maintenances/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1maintenances/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1maintenances/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1maintenances/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenances/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1maintenances/post/responses/422/content/application~1json/examples/Missing required values":{"value":{"title":["is missing"],"start_time":["is missing"],"end_time":["is missing"]},"key":"Missing required values","summary":"Missing required values","description":"Returned when payload is missing values for mandatory fields.\n","id":"paths/~1hubs~1{subdomain}~1maintenances/post/responses/422/content/application~1json/examples/Missing required values"},"paths/~1hubs~1{subdomain}~1maintenances/post/responses/422/content/application~1json/examples/Wrong service IDs":{"value":{"service_statuses":["wrong_hub"]},"key":"Wrong service IDs","summary":"Wrong service IDs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't match any service in currently used Hub. Same error is returned when there is no service with such ID as well as when service with such ID exists but in different Hub."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenances/post/responses/422/content/application~1json/examples/Wrong service IDs"},"paths/~1hubs~1{subdomain}~1maintenances/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1maintenances/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1maintenances/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1maintenances/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1maintenances/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenances/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1maintenances/get/responses/422/content/application~1json/examples/Invalid deleted param":{"value":{"deleted":["must be one of: true, false, all"]},"key":"Invalid deleted param","summary":"Invalid deleted param","description":"Returned when deleted param is invalid.\n","id":"paths/~1hubs~1{subdomain}~1maintenances/get/responses/422/content/application~1json/examples/Invalid deleted param"},"paths/~1hubs~1{subdomain}~1maintenances/get/responses/422/content/application~1json/examples/Invalid extend param":{"value":{"extend[0]":["must be one of: flags"]},"key":"Invalid extend param","summary":"Invalid extend param","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains property that does not exist or not support extending."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenances/get/responses/422/content/application~1json/examples/Invalid extend param"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/404/content/application~1json/examples/Invalid maintenance_id":{"value":{"message":"record not found"},"key":"Invalid maintenance_id","summary":"Invalid maintenance_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/404/content/application~1json/examples/Invalid maintenance_id"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/422/content/application~1json/examples/Invalid extend param":{"value":{"extend[0]":["must be one of: flags"]},"key":"Invalid extend param","summary":"Invalid extend param","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains property that does not exist or not support extending."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/get/responses/422/content/application~1json/examples/Invalid extend param"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/404/content/application~1json/examples/Invalid maintenance_id":{"value":{"message":"record not found"},"key":"Invalid maintenance_id","summary":"Invalid maintenance_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/422/content/application~1json/examples/Wrong service IDs":{"value":{"service_statuses":["wrong_hub"]},"key":"Wrong service IDs","summary":"Wrong service IDs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" doesn't match any service in currently used Hub. Same error is returned when there is no service with such ID as well as when service with such ID exists but in different Hub."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/put/responses/422/content/application~1json/examples/Wrong service IDs"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/200/content/application~1json/examples/OK":{"value":{"message":"OK"},"key":"OK","summary":"OK","description":"Operation was successful.","id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/200/content/application~1json/examples/OK"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id":{"value":{"message":"record not found"},"key":"Invalid incident_id","summary":"Invalid incident_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1maintenances~1{maintenance_id}/delete/responses/404/content/application~1json/examples/Invalid incident_id"},"paths/~1hubs~1{subdomain}~1incident_templates/post/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates/post/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1incident_templates/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incident_templates/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incident_templates/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incident_templates/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incident_templates/post/responses/422/content/application~1json/examples/Missing required values":{"value":{"template":["must_have_title_or_body"]},"key":"Missing required values","summary":"Missing required values","description":"Returned when payload is missing values for mandatory fields.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates/post/responses/422/content/application~1json/examples/Missing required values"},"paths/~1hubs~1{subdomain}~1incident_templates/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incident_templates/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incident_templates/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incident_templates/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incident_templates/get/responses/422/content/application~1json/examples/Invalid deleted param":{"value":{"deleted":["must be one of: true, false, all"]},"key":"Invalid deleted param","summary":"Invalid deleted param","description":"Returned when deleted param is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates/get/responses/422/content/application~1json/examples/Invalid deleted param"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/404/content/application~1json/examples/Invalid incident_template_id":{"value":{"message":"record not found"},"key":"Invalid incident_template_id","summary":"Invalid incident_template_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/get/responses/404/content/application~1json/examples/Invalid incident_template_id"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/404/content/application~1json/examples/Invalid incident_template_id":{"value":{"message":"record not found"},"key":"Invalid incident_template_id","summary":"Invalid incident_template_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/404/content/application~1json/examples/Invalid incident_template_id"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"service_statuses":["not all services belong to the hub"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when some of service IDs are invalid or does not belong to current Hub.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/200/content/application~1json/examples/OK":{"value":{"message":"OK"},"key":"OK","summary":"OK","description":"Operation was successful.","id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/200/content/application~1json/examples/OK"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/404/content/application~1json/examples/Invalid incident_template_id":{"value":{"message":"record not found"},"key":"Invalid incident_template_id","summary":"Invalid incident_template_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1incident_templates~1{incident_template_id}/delete/responses/404/content/application~1json/examples/Invalid incident_template_id"},"paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/422/content/application~1json/examples/Missing required values":{"value":{"template":["must_have_title_or_body"]},"key":"Missing required values","summary":"Missing required values","description":"Returned when payload is missing values for mandatory fields.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates/post/responses/422/content/application~1json/examples/Missing required values"},"paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/422/content/application~1json/examples/Invalid deleted param":{"value":{"deleted":["must be one of: true, false, all"]},"key":"Invalid deleted param","summary":"Invalid deleted param","description":"Returned when deleted param is invalid.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates/get/responses/422/content/application~1json/examples/Invalid deleted param"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/404/content/application~1json/examples/Invalid maintenance_template_id":{"value":{"message":"record not found"},"key":"Invalid maintenance_template_id","summary":"Invalid maintenance_template_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/get/responses/404/content/application~1json/examples/Invalid maintenance_template_id"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/404/content/application~1json/examples/Invalid maintenance_template_id":{"value":{"message":"record not found"},"key":"Invalid maintenance_template_id","summary":"Invalid maintenance_template_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/404/content/application~1json/examples/Invalid maintenance_template_id"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"service_statuses":["not all services belong to the hub"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when some of service IDs are invalid or does not belong to current Hub.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/200/content/application~1json/examples/OK":{"value":{"message":"OK"},"key":"OK","summary":"OK","description":"Operation was successful.","id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/200/content/application~1json/examples/OK"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/404/content/application~1json/examples/Invalid maintenance_template_id":{"value":{"message":"record not found"},"key":"Invalid maintenance_template_id","summary":"Invalid maintenance_template_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1maintenance_templates~1{maintenance_template_id}/delete/responses/404/content/application~1json/examples/Invalid maintenance_template_id"},"paths/~1hubs~1{subdomain}~1platform_alert/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1platform_alert/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1platform_alert/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1platform_alert/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1platform_alert/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1platform_alert/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1platform_alert/post/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1platform_alert/post/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1platform_alert/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1platform_alert/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1platform_alert/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1platform_alert/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1platform_alert/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1platform_alert/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1platform_alert/post/responses/422/content/application~1json/examples/Empty body":{"value":{"body":["is missing"]},"key":"Empty body","summary":"Empty body","description":"Returned when trying to set Platform Alert without body message.\n","id":"paths/~1hubs~1{subdomain}~1platform_alert/post/responses/422/content/application~1json/examples/Empty body"},"paths/~1hubs/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs/get/responses/403/content/application~1json/examples/No access to any of Hubs":{"value":{"message":"not authorized"},"key":"No access to any of Hubs","summary":"No access to any of Hubs","description":"Returned when Member does not have access to even one Hub inside current account.\n","id":"paths/~1hubs/get/responses/403/content/application~1json/examples/No access to any of Hubs"},"paths/~1hubs/get/responses/422/content/application~1json/examples/Invalid type param":{"value":{"type":["must be one of: primary, connected"]},"key":"Invalid type param","summary":"Invalid type param","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param is invalid."},"children":[]}]}]}],"id":"paths/~1hubs/get/responses/422/content/application~1json/examples/Invalid type param"},"paths/~1hubs~1{subdomain}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}/put/responses/404/content/application~1json/examples/Invalid maintenance_id":{"value":{"message":"record not found"},"key":"Invalid maintenance_id","summary":"Invalid maintenance_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"},"paths/~1hubs~1{subdomain}/put/responses/422/content/application~1json/examples/Wrong product_url format":{"value":{"product_url":["invalid format"]},"key":"Wrong product_url format","summary":"Wrong product_url format","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not have a valid URL format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example when it doesn't have protocol ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") specified."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}/put/responses/422/content/application~1json/examples/Wrong product_url format"},"paths/~1hubs~1{subdomain}~1status~1counters/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1status~1counters/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1status~1counters/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1status~1counters/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1status~1counters/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1status~1counters/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/422/content/application~1json/examples/Invalid sort_prop param":{"value":{"sort_prop":["must be one of: position, created_at, updated_at"]},"key":"Invalid sort_prop param","summary":"Invalid sort_prop param","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort_prop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param is invalid."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_hubs/get/responses/422/content/application~1json/examples/Invalid sort_prop param"},"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Invalid or not available subdomain":{"value":{"subdomain":["already taken","not allowed"]},"key":"Invalid or not available subdomain","summary":"Invalid or not available subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid or not available."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Invalid or not available subdomain"},"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Quota has been reached":{"value":{"connected_hub":["limit reached"]},"key":"Quota has been reached","summary":"Quota has been reached","description":"Returned when the Connected Hubs quota for current Primary\nHub has been reached or Connected Hubs are not available\nfor current Primary Hub plan.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Quota has been reached"},"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Wrong product_url format":{"value":{"product_url":["invalid format"]},"key":"Wrong product_url format","summary":"Wrong product_url format","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not have a valid URL format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example when it doesn't have protocol ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") specified."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_hubs/post/responses/422/content/application~1json/examples/Wrong product_url format"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/get/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/404/content/application~1json/examples/Invalid maintenance_id":{"value":{"message":"record not found"},"key":"Invalid maintenance_id","summary":"Invalid maintenance_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/404/content/application~1json/examples/Invalid maintenance_id"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/422/content/application~1json/examples/Wrong product_url format":{"value":{"product_url":["invalid format"]},"key":"Wrong product_url format","summary":"Wrong product_url format","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not have a valid URL format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example when it doesn't have protocol ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") specified."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/put/responses/422/content/application~1json/examples/Wrong product_url format"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/200/content/application~1json/examples/OK":{"value":{"message":"OK"},"key":"OK","summary":"OK","description":"Operation was successful.","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/200/content/application~1json/examples/OK"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/404/content/application~1json/examples/Invalid incident_id":{"value":{"message":"record not found"},"key":"Invalid incident_id","summary":"Invalid incident_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/404/content/application~1json/examples/Invalid incident_id"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Invalid or not available subdomain":{"value":{"subdomain":["already taken","not allowed"]},"key":"Invalid or not available subdomain","summary":"Invalid or not available subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid or not available."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Invalid or not available subdomain"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Quota has been reached":{"value":{"connected_hub":["limit reached"]},"key":"Quota has been reached","summary":"Quota has been reached","description":"Returned when the Connected Hubs quota for current Primary\nHub has been reached or Connected Hubs are not available\nfor current Primary Hub plan.\n","id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Quota has been reached"},"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Wrong product_url format":{"value":{"product_url":["invalid format"]},"key":"Wrong product_url format","summary":"Wrong product_url format","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not have a valid URL format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example when it doesn't have protocol ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") specified."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_hubs~1{connected_subdomain}~1copy/post/responses/422/content/application~1json/examples/Wrong product_url format"},"paths/~1hubs~1{subdomain}~1appearance/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1appearance/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1appearance/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1appearance/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1appearance/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1appearance/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1appearance/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1appearance/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1appearance/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1appearance/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1appearance/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1appearance/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1appearance/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1appearance/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1appearance/put/responses/422/content/application~1json/examples/Missing navbar item url":{"value":{"navbar_item.url":["cant be blank"]},"key":"Missing navbar item url","summary":"Missing navbar item url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when setting just the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"navbar_item"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1appearance/put/responses/422/content/application~1json/examples/Missing navbar item url"},"paths/~1hubs~1{subdomain}~1access_restriction/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1access_restriction/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1access_restriction/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1access_restriction/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1access_restriction~1saml/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/422/content/application~1json/examples/IdP metadata not compatible with SLO":{"value":{"idp_metadata":["must contain the SLO target URL"]},"key":"IdP metadata not compatible with SLO","summary":"IdP metadata not compatible with SLO","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when trying to enable SLO while using IdP metadata that doesn't support SLO."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For example due to missing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SingleLgoutService"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1access_restriction~1saml/put/responses/422/content/application~1json/examples/IdP metadata not compatible with SLO"},"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/422/content/application~1json/examples/Domains whitelist not set":{"value":{"domains_whitelist_enabled":["selected protection method requires enabled domains whitelist"]},"key":"Domains whitelist not set","summary":"Domains whitelist not set","description":"Returned when trying to enable Google OAuth without having domains whitelist enabled.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1google_oauth/put/responses/422/content/application~1json/examples/Domains whitelist not set"},"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/422/content/application~1json/examples/Too short password":{"value":{"password":["length must be within 8 - 255"]},"key":"Too short password","summary":"Too short password","description":"Returned when trying to enable password protection with too short password.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1global_password/put/responses/422/content/application~1json/examples/Too short password"},"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/422/content/application~1json/examples/Google OAuth is enabled":{"value":{"enabled":["can not be disabled because selected protection method requires enabled domains whitelist"]},"key":"Google OAuth is enabled","summary":"Google OAuth is enabled","description":"Returned when trying to disable domains whitelist while Google OAuth is an active access restriction method for current Hub.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1domains_whitelist/put/responses/422/content/application~1json/examples/Google OAuth is enabled"},"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/422/content/application~1json/examples/Invalid address format":{"value":{"ip_whitelist":["provided IP(s) address(es) is(are) in an invalid format"]},"key":"Invalid address format","summary":"Invalid address format","description":"Returned when trying to use IP address in format other than IP V4 or IP V4 CIDR.\n","id":"paths/~1hubs~1{subdomain}~1access_restriction~1ip_whitelist/put/responses/422/content/application~1json/examples/Invalid address format"},"paths/~1hubs~1{subdomain}~1assets/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1assets/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1assets/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1assets/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1assets/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1assets/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1assets/post/responses/422/content/application~1json/examples/Invalid image type":{"value":{"file":["invalid content type"]},"key":"Invalid image type","summary":"Invalid image type","description":"Returned when uploading an asset file that has a wrong content type. For example is not an image for logo upload.\n","id":"paths/~1hubs~1{subdomain}~1assets/post/responses/422/content/application~1json/examples/Invalid image type"},"paths/~1hubs~1{subdomain}~1assets/post/responses/422/content/application~1json/examples/Not-square favicon image":{"value":{"file":["image should be square"]},"key":"Not-square favicon image","summary":"Not-square favicon image","description":"Returned when uploading image that is not a square as a favicon.\n","id":"paths/~1hubs~1{subdomain}~1assets/post/responses/422/content/application~1json/examples/Not-square favicon image"},"paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/200/content/application~1json/examples/OK":{"value":{"message":"OK"},"key":"OK","summary":"OK","description":"Operation was successful.","id":"paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/200/content/application~1json/examples/OK"},"paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1assets~1{asset_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1groups/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1groups/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1groups/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1groups/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1groups/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1groups/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1groups/get/responses/422/content/application~1json/examples/Wrong parameter value":{"value":{"archived":["must be one of: true, false, all"]},"key":"Wrong parameter value","summary":"Wrong parameter value","description":"Returned when archived param is invalid.\n","id":"paths/~1hubs~1{subdomain}~1groups/get/responses/422/content/application~1json/examples/Wrong parameter value"},"paths/~1hubs~1{subdomain}~1groups/get/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1groups/get/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1groups/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1groups/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1groups/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1groups/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1groups/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1groups/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1groups/post/responses/422/content/application~1json/examples/Empty name":{"value":{"name":["must be filled"]},"key":"Empty name","summary":"Empty name","description":"Returned when trying to create a group without a name.\n","id":"paths/~1hubs~1{subdomain}~1groups/post/responses/422/content/application~1json/examples/Empty name"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid group_id":{"value":{"message":"record not found"},"key":"Invalid group_id","summary":"Invalid group_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid group_id"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/403/content/application~1json/examples/Group is archived":{"value":{"message":"not authorized"},"key":"Group is archived","summary":"Group is archived","description":"Returned when trying to modify group that was archived.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/403/content/application~1json/examples/Group is archived"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/422/content/application~1json/examples/Empty name":{"value":{"name":["must be filled"]},"key":"Empty name","summary":"Empty name","description":"Returned when trying to set an empty group name.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/put/responses/422/content/application~1json/examples/Empty name"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/403/content/application~1json/examples/Group is archived":{"value":{"message":"not authorized"},"key":"Group is archived","summary":"Group is archived","description":"Returned when trying to modify group that was archived.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/403/content/application~1json/examples/Group is archived"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/403/content/application~1json/examples/Group is archived":{"value":{"message":"not authorized"},"key":"Group is archived","summary":"Group is archived","description":"Returned when trying to modify group that was archived.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/403/content/application~1json/examples/Group is archived"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1archive/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/403/content/application~1json/examples/Group is archived":{"value":{"message":"not authorized"},"key":"Group is archived","summary":"Group is archived","description":"Returned when trying to modify group that was archived.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/403/content/application~1json/examples/Group is archived"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid service_id":{"value":{"message":"record not found"},"key":"Invalid service_id","summary":"Invalid service_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid service_id"},"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1groups~1{group_id}~1reorder/put/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1services/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1services/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1services/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1services/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1services/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1services/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1services/get/responses/422/content/application~1json/examples/Wrong parameter value":{"value":{"archived":["must be one of: true, false, all"]},"key":"Wrong parameter value","summary":"Wrong parameter value","description":"Returned when archived param is invalid.\n","id":"paths/~1hubs~1{subdomain}~1services/get/responses/422/content/application~1json/examples/Wrong parameter value"},"paths/~1hubs~1{subdomain}~1services/get/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1services/get/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1services/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1services/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1services/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1services/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1services/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1services/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1services/post/responses/404/content/application~1json/examples/Invalid service_id":{"value":{"message":"record not found"},"key":"Invalid service_id","summary":"Invalid service_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1services/post/responses/404/content/application~1json/examples/Invalid service_id"},"paths/~1hubs~1{subdomain}~1services/post/responses/422/content/application~1json/examples/Empty name":{"value":{"name":["must be filled"]},"key":"Empty name","summary":"Empty name","description":"Returned when trying to create a service without a name.\n","id":"paths/~1hubs~1{subdomain}~1services/post/responses/422/content/application~1json/examples/Empty name"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid service_id":{"value":{"message":"record not found"},"key":"Invalid service_id","summary":"Invalid service_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid service_id"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/404/content/application~1json/examples/Invalid service_id":{"value":{"message":"record not found"},"key":"Invalid service_id","summary":"Invalid service_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/404/content/application~1json/examples/Invalid service_id"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/422/content/application~1json/examples/Empty name":{"value":{"name":["must be filled"]},"key":"Empty name","summary":"Empty name","description":"Returned when trying to set an empty service name.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/put/responses/422/content/application~1json/examples/Empty name"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/403/content/application~1json/examples/Service is archived":{"value":{"message":"not authorized"},"key":"Service is archived","summary":"Service is archived","description":"Returned when trying to modify service that was archived.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/403/content/application~1json/examples/Service is archived"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid service_id":{"value":{"message":"record not found"},"key":"Invalid service_id","summary":"Invalid service_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid service_id"},"paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/404/content/application~1json/examples/Invalid service_id":{"value":{"message":"record not found"},"key":"Invalid service_id","summary":"Invalid service_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/404/content/application~1json/examples/Invalid service_id"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1archive/put/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid service_id":{"value":{"message":"record not found"},"key":"Invalid service_id","summary":"Invalid service_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/404/content/application~1json/examples/Invalid service_id"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1reorder/put/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations/get/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/get/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be primary"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Connected Hub a request valid only for Primary or Standalone Hub.\n","id":"paths/~1hubs~1{subdomain}~1services~1{service_id}~1integrations~1{integration_slug}/put/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1connected_groups/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_groups/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1connected_groups/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1connected_groups/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1connected_groups/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_groups/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1connected_groups/get/responses/422/content/application~1json/examples/Invalid deleted param":{"value":{"deleted":["must be one of: true, false, all"]},"key":"Invalid deleted param","summary":"Invalid deleted param","description":"Returned when deleted param is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_groups/get/responses/422/content/application~1json/examples/Invalid deleted param"},"paths/~1hubs~1{subdomain}~1connected_groups/get/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be connected"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Primary or Standalone Hub a request valid only for Connected Hub.\n","id":"paths/~1hubs~1{subdomain}~1connected_groups/get/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid incident_id":{"value":{"message":"record not found"},"key":"Invalid incident_id","summary":"Invalid incident_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid incident_id"},"paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be connected"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Primary or Standalone Hub a request valid only for Connected Hub.\n","id":"paths/~1hubs~1{subdomain}~1connected_groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1connected_services/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_services/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1connected_services/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1connected_services/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1connected_services/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_services/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1connected_services/get/responses/422/content/application~1json/examples/Invalid deleted param":{"value":{"deleted":["must be one of: true, false, all"]},"key":"Invalid deleted param","summary":"Invalid deleted param","description":"Returned when deleted param is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_services/get/responses/422/content/application~1json/examples/Invalid deleted param"},"paths/~1hubs~1{subdomain}~1connected_services/get/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be connected"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Primary or Standalone Hub a request valid only for Connected Hub.\n","id":"paths/~1hubs~1{subdomain}~1connected_services/get/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1connected_services/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_services/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1connected_services/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1connected_services/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1connected_services/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_services/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1connected_services/post/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be connected"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Primary or Standalone Hub a request valid only for Connected Hub.\n","id":"paths/~1hubs~1{subdomain}~1connected_services/post/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be connected"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Primary or Standalone Hub a request valid only for Connected Hub.\n","id":"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid service_id":{"value":{"message":"record not found"},"key":"Invalid service_id","summary":"Invalid service_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/404/content/application~1json/examples/Invalid service_id"},"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type":{"value":{"message":["hub must be connected"]},"key":"Invalid Hub Type","summary":"Invalid Hub Type","description":"Returned when performing on Primary or Standalone Hub a request valid only for Connected Hub.\n","id":"paths/~1hubs~1{subdomain}~1connected_services~1{service_id}/delete/responses/422/content/application~1json/examples/Invalid Hub Type"},"paths/~1hubs~1{subdomain}~1external_applications/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1external_applications/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1external_applications/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1external_applications/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1external_applications/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1external_applications/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1external_applications~1{external_application_slug}~1reset_token/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1uptime/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1uptime/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1uptime/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1uptime/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1uptime/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1uptime/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1uptime/get/responses/422/content/application~1json/examples/Invalid end date":{"value":{"end_date":["must be a date"]},"key":"Invalid end date","summary":"Invalid end date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when date param can't be parsed as valid date."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date=2025-02-31"},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1uptime/get/responses/422/content/application~1json/examples/Invalid end date"},"paths/~1hubs~1{subdomain}~1uptime/get/responses/422/content/application~1json/examples/start and end date too far apart":{"value":{"end_date":["must be less than or equal to 2024-08-01"]},"key":"start and end date too far apart","summary":"start and end date too far apart","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param is too far apart from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response specifies maximum value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that can be used with provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1uptime/get/responses/422/content/application~1json/examples/start and end date too far apart"},"paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/422/content/application~1json/examples/Invalid end date":{"value":{"end_date":["must be a date"]},"key":"Invalid end date","summary":"Invalid end date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when date param can't be parsed as valid date."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date=2025-02-31"},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/422/content/application~1json/examples/Invalid end date"},"paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/422/content/application~1json/examples/start and end date too far apart":{"value":{"end_date":["must be less than or equal to 2024-08-01"]},"key":"start and end date too far apart","summary":"start and end date too far apart","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param is too far apart from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response specifies maximum value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that can be used with provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1uptime~1daily/get/responses/422/content/application~1json/examples/start and end date too far apart"},"paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid end date":{"value":{"end_date":["must be a date"]},"key":"Invalid end date","summary":"Invalid end date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when date param can't be parsed as valid date."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date=2025-02-31"},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/422/content/application~1json/examples/Invalid end date"},"paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/422/content/application~1json/examples/start and end date too far apart":{"value":{"end_date":["must be less than or equal to 2024-08-01"]},"key":"start and end date too far apart","summary":"start and end date too far apart","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param is too far apart from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response specifies maximum value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that can be used with provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1uptime~1groups~1{group_id}/get/responses/422/content/application~1json/examples/start and end date too far apart"},"paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid end date":{"value":{"end_date":["must be a date"]},"key":"Invalid end date","summary":"Invalid end date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when date param can't be parsed as valid date."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date=2025-02-31"},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/422/content/application~1json/examples/Invalid end date"},"paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/422/content/application~1json/examples/start and end date too far apart":{"value":{"end_date":["must be less than or equal to 2024-08-01"]},"key":"start and end date too far apart","summary":"start and end date too far apart","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" param is too far apart from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Response specifies maximum value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that can be used with provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1uptime~1services~1{service_id}/get/responses/422/content/application~1json/examples/start and end date too far apart"},"paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example":{"value":{"address":"example@statushub.com","method_name":"email","services_selection":{"all":true}},"key":"Minimal example","summary":"Minimal example","description":"Minimal example creating email subscription.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example"},"paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection":{"value":{"address":"example@statushub.com","method_name":"email","services_selection":{"service_ids":[17155,17363]},"less_verbose":true},"key":"Basic example with less verbose and services selection","summary":"Basic example with less verbose and services selection","description":"Example creating email subscription with less verbose option and services selection.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection"},"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated address":{"value":{"address":["already taken","already subscribed"]},"key":"Duplicated address","summary":"Duplicated address","description":"Returned when there is more than one subscription for any method name for current Hub.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated address"},"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated method":{"value":{"method_name":["already subscribed"]},"key":"Duplicated method","summary":"Duplicated method","description":"Returned when there is more than one subscription for any method name for current Subscriber.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated method"},"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid address":{"value":{"address":["invalid"]},"key":"Invalid address","summary":"Invalid address","description":"Returned when address of subscription is invalid for given method name.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid address"},"paths/~1hubs~1{subdomain}~1subscriptions/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscriptions/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscriptions/get/responses/422/content/application~1json/examples/Wrong parameter value":{"value":{"deleted":["must be one of: true, false, all"]},"key":"Wrong parameter value","summary":"Wrong parameter value","description":"Returned when deleted param is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions/get/responses/422/content/application~1json/examples/Wrong parameter value"},"paths/~1hubs~1{subdomain}~1subscriptions/get/responses/422/content/application~1json/examples/Invalid extend param":{"value":{"extend[0]":["must be one of: flags"]},"key":"Invalid extend param","summary":"Invalid extend param","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains property that does not exist or not support extending."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscriptions/get/responses/422/content/application~1json/examples/Invalid extend param"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscription ID":{"value":{"message":"record not found"},"key":"Invalid Subscription ID","summary":"Invalid Subscription ID","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscription ID"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Wrong parameter value":{"value":{"deleted":["must be one of: true, false, all"]},"key":"Wrong parameter value","summary":"Wrong parameter value","description":"Returned when deleted param is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Wrong parameter value"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Invalid extend param":{"value":{"extend[0]":["must be one of: flags"]},"key":"Invalid extend param","summary":"Invalid extend param","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains property that does not exist or not support extending."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Invalid extend param"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscription ID":{"value":{"message":"record not found"},"key":"Invalid Subscription ID","summary":"Invalid Subscription ID","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscription ID"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/422/content/application~1json/examples/Missing services selection":{"value":{"services_selection":["is missing"]},"key":"Missing services selection","summary":"Missing services selection","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services_selection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is missing or incomplete."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example of incomplete "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services_selection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"services_selection\": {\"all\": false}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which would indicate that a subset of services should be used but the services list was not provided."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/put/responses/422/content/application~1json/examples/Missing services selection"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Success":{"value":{"message":"OK"},"key":"Success","summary":"Success","description":"Operation was successful.","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Success"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID":{"value":{"message":"subscriber not found"},"key":"Invalid Subscriber ID","summary":"Invalid Subscriber ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when SubscriberID is invalid."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscription ID":{"value":{"message":"record not found"},"key":"Invalid Subscription ID","summary":"Invalid Subscription ID","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscription ID"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Not allowed":{"value":{"message":"not authorized"},"key":"Not allowed","summary":"Not allowed","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when restoring subscription is not allowed because such subscription would violate validations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For example when attempting to restore subscription with address that is already being used by an active (not deleted) subscription in the same Hub."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Not allowed"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscription ID":{"value":{"message":"record not found"},"key":"Invalid Subscription ID","summary":"Invalid Subscription ID","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscription ID"},"paths/~1hubs~1{subdomain}~1subscribers/post/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1subscribers/post/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1subscribers/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscribers/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscribers/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscribers/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Already subscribed":{"value":{"subscriptions[0].address":["already subscribed","already taken"]},"key":"Already subscribed","summary":"Already subscribed","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when address is already subscribed to current Hub."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions[0]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to first subscription passed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of request body."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Already subscribed"},"paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Duplicated method":{"value":{"subscriptions":["can not have multiple identical methods"]},"key":"Duplicated method","summary":"Duplicated method","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when there is more than one subscription for any method name."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions[0]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to first subscription passed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of request body."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Duplicated method"},"paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Invalid address":{"value":{"subscriptions[2].address":["invalid"]},"key":"Invalid address","summary":"Invalid address","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when address of subscription is invalid for given method name."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions[2]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to first subscription passed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of request body."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Invalid address"},"paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Invalid service IDs":{"value":{"subscriptions[1].services_selection":["invalid"]},"key":"Invalid service IDs","summary":"Invalid service IDs","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when address of subscription is invalid for given method name."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions[1]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to first subscription passed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of request body."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers/post/responses/422/content/application~1json/examples/Invalid service IDs"},"paths/~1hubs~1{subdomain}~1subscribers/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscribers/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscribers/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscribers/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscribers/get/responses/422/content/application~1json/examples/Wrong parameter value":{"value":{"deleted":["must be one of: true, false, all"]},"key":"Wrong parameter value","summary":"Wrong parameter value","description":"Returned when deleted param is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers/get/responses/422/content/application~1json/examples/Wrong parameter value"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/404/content/application~1json/examples/Invalid Subscriber ID":{"value":{"message":"record not found"},"key":"Invalid Subscriber ID","summary":"Invalid Subscriber ID","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/get/responses/404/content/application~1json/examples/Invalid Subscriber ID"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/404/content/application~1json/examples/Invalid subscriber_id":{"value":{"message":"record not found"},"key":"Invalid subscriber_id","summary":"Invalid subscriber_id","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/404/content/application~1json/examples/Invalid subscriber_id"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/422/content/application~1json/examples/Duplicated IDP ID":{"value":{"idp_id":["already taken"]},"key":"Duplicated IDP ID","summary":"Duplicated IDP ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idp_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has already been used in current Hub."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/put/responses/422/content/application~1json/examples/Duplicated IDP ID"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/200/content/application~1json/examples/Success":{"value":{"message":"OK"},"key":"Success","summary":"Success","description":"Operation was successful.","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/200/content/application~1json/examples/Success"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID":{"value":{"message":"record not found"},"key":"Invalid Subscriber ID","summary":"Invalid Subscriber ID","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example":{"value":{"address":"example@statushub.com","method_name":"email","services_selection":{"all":true}},"key":"Minimal example","summary":"Minimal example","description":"Minimal example creating email subscription.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Minimal example"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection":{"value":{"address":"example@statushub.com","method_name":"email","services_selection":{"service_ids":[17155,17363]},"less_verbose":true},"key":"Basic example with less verbose and services selection","summary":"Basic example with less verbose and services selection","description":"Example creating email subscription with less verbose option and services selection.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/requestBody/content/application~1json/examples/Basic example with less verbose and services selection"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated address":{"value":{"address":["already taken","already subscribed"]},"key":"Duplicated address","summary":"Duplicated address","description":"Returned when there is more than one subscription for any method name for current Hub.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated address"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated method":{"value":{"method_name":["already subscribed"]},"key":"Duplicated method","summary":"Duplicated method","description":"Returned when there is more than one subscription for any method name for current Subscriber.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Duplicated method"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid address":{"value":{"address":["invalid"]},"key":"Invalid address","summary":"Invalid address","description":"Returned when address of subscription is invalid for given method name.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid address"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid Subscriber ID":{"value":{"subscriber_id":["invalid"]},"key":"Invalid Subscriber ID","summary":"Invalid Subscriber ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when SubscriberID is invalid."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Returned also when trying to create Subscription for deleted Subscriber."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/post/responses/422/content/application~1json/examples/Invalid Subscriber ID"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid Subscriber ID":{"value":{"message":"subscriber not found"},"key":"Invalid Subscriber ID","summary":"Invalid Subscriber ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when SubscriberID is invalid."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/404/content/application~1json/examples/Invalid Subscriber ID"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/422/content/application~1json/examples/Wrong parameter value":{"value":{"deleted":["must be one of: true, false, all"]},"key":"Wrong parameter value","summary":"Wrong parameter value","description":"Returned when deleted param is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/422/content/application~1json/examples/Wrong parameter value"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/422/content/application~1json/examples/Invalid extend param":{"value":{"extend[0]":["must be one of: flags"]},"key":"Invalid extend param","summary":"Invalid extend param","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains property that does not exist or not support extending."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions/get/responses/422/content/application~1json/examples/Invalid extend param"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscriber ID":{"value":{"message":"subscriber not found"},"key":"Invalid Subscriber ID","summary":"Invalid Subscriber ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when SubscriberID is invalid."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscriber ID"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscription ID":{"value":{"message":"record not found"},"key":"Invalid Subscription ID","summary":"Invalid Subscription ID","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Invalid Subscription ID"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Wrong parameter value":{"value":{"deleted":["must be one of: true, false, all"]},"key":"Wrong parameter value","summary":"Wrong parameter value","description":"Returned when deleted param is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Wrong parameter value"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Invalid extend param":{"value":{"extend[0]":["must be one of: flags"]},"key":"Invalid extend param","summary":"Invalid extend param","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"extend"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains property that does not exist or not support extending."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/get/responses/422/content/application~1json/examples/Invalid extend param"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed JSON":{"value":{"status":"400,","error":"JSON error: Error occurred while parsing request parameters"},"key":"Malformed JSON","summary":"Malformed JSON","description":"Returned when payload is not a valid JSON content.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed JSON"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscriber ID":{"value":{"message":"subscriber not found"},"key":"Invalid Subscriber ID","summary":"Invalid Subscriber ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when SubscriberID is invalid."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscriber ID"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscription ID":{"value":{"message":"record not found"},"key":"Invalid Subscription ID","summary":"Invalid Subscription ID","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Invalid Subscription ID"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/422/content/application~1json/examples/Missing services selection":{"value":{"services_selection":["is missing"]},"key":"Missing services selection","summary":"Missing services selection","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services_selection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is missing or incomplete."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Example of incomplete "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services_selection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"services_selection\": {\"all\": false}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which would indicate that a subset of services should be used but the services list was not provided."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/put/responses/422/content/application~1json/examples/Missing services selection"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Success":{"value":{"message":"OK"},"key":"Success","summary":"Success","description":"Operation was successful.","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/200/content/application~1json/examples/Success"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID":{"value":{"message":"subscriber not found"},"key":"Invalid Subscriber ID","summary":"Invalid Subscriber ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when SubscriberID is invalid."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscriber ID"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscription ID":{"value":{"message":"record not found"},"key":"Invalid Subscription ID","summary":"Invalid Subscription ID","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Invalid Subscription ID"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/401/content/application~1json/examples/Invalid API key":{"value":{"message":["user_unauthorized"]},"key":"Invalid API key","summary":"Invalid API key","description":"Returned when API key is invalid.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/401/content/application~1json/examples/Invalid API key"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Insufficient API key role":{"value":{"message":"not authorized"},"key":"Insufficient API key role","summary":"Insufficient API key role","description":"Returned when API key overrides Member role to not powerful enough to perform requested operation.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Insufficient API key role"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Not allowed":{"value":{"message":"not authorized"},"key":"Not allowed","summary":"Not allowed","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when restoring subscription is not allowed because such subscription would violate validations."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For example when attempting to restore subscription with address that is already being used by an active (not deleted) subscription in the same Hub."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/403/content/application~1json/examples/Not allowed"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid subdomain":{"value":{"message":"record not found"},"key":"Invalid subdomain","summary":"Invalid subdomain","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subdomain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is invalid. Same error is returned when there is no Hub with such subdomain as well as when Hub with such subdomain exists but current member does not have sufficient access to it."},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid subdomain"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscriber ID":{"value":{"message":"subscriber not found"},"key":"Invalid Subscriber ID","summary":"Invalid Subscriber ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when SubscriberID is invalid."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscriber ID"},"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscription ID":{"value":{"message":"record not found"},"key":"Invalid Subscription ID","summary":"Invalid Subscription ID","description":"Returned when record with specified ID does not exist or current user does not have permissions to access it.\n","id":"paths/~1hubs~1{subdomain}~1subscribers~1{subscriber_id}~1subscriptions~1{subscription_id}~1restore/put/responses/404/content/application~1json/examples/Invalid Subscription ID"}},"securitySchemeStore":{"ApiKeyAuth":{"id":"ApiKeyAuth","type":"apiKey","in":"header","paramName":"X-API-KEY"}},"servers":[{"url":"https://{accountSubdomain}.app.statushub.io/api/v3","description":"Main US region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account","description":"Unique subdomain of your account"}}},{"url":"https://{accountSubdomain}.app-eu1.statushub.io/api/v3","description":"EU region","variables":{"accountSubdomain":{"default":"subdomain-of-your-account","description":"Unique subdomain of your account"}}}],"specType":"openapi"},"options":{"excludeFromSearch":false,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/api-v3-openapi.json?download"},{"url":"/_bundle/api-v3-openapi.yaml?download"}],"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"StatusHub Management API","description":"# The StatusHub Management API v3\n\nStatusHub Management API V3 is a REST API intended to be an alternative\nto StatusHub Control Panel web interface.<br>\nExample use cases:\n- Automation of incidents creation and update,\n- Automation of Hub services management,\n- Automation of creation and deletion of Connected Hubs.\n\n## Previous API versions\n\nStatusHub Management API V3 replaces the Management API V2 which is now\ndeprecated.<br>\nManagement API V2 documentation has been moved to a new address:<br>\n[https://api-v2-docs.statushub.com](https://api-v2-docs.statushub.com)\n\n## StatusHub regions and API URL\n\nAll API requests should be made on hostname used to sign in to StatusHub\nControl Panel.<br>\nFor example if team members sign in to account on:<br>\n`https://company.app.statushub.io`<br>\nthen API requests should be made with following prefix:<br>\n`https://company.app.statushub.io/api/v3`\n\n#### EU region\n\nSame rule follows for customers using EU region and then\nthe example would be:<br>\nIf team members sign in to account on:<br>\n`https://company.app-eu1.statushub.io`<br>\nthen API requests should be made with following prefix:<br>\n`https://company.app-eu1.statushub.io/api/v3`\n\n## Rate limiting\n\nStatusHub API has two rate limits:\n\n- GET requests - 30 requests per second\n- All other requests - 5 requests per second\n\nRate limit is bound to the API Key used for authentication.<br>\nWhen the rate limit is exceeded, StatusHub API will respond with:\n\n  - 429 response code\n  - `{\"error\":\"Too many requests - please retry later\"}` response\n  - Retry-After response header\n\nIn special cases, certain API methods may have different rate limits which will be mentioned in the API method description.\n\n## Time zones\n\nAll date/time parameters should be passed in UTC timezone\nregardless of the default Hub timezone settings.\n\n## Filtering events by time range\n\nEvents like Incident or Maintenance events can be filtered by time\nrange.<br>\nThere are two optional parameters in INDEX endpoints:\n- `start_time`,\n- `end_time`.\n\nFiltering logic is returning those events which period of occurrence\noverlaps with `start_time` and `end_time` range.<br>\nAlso, providing just one of range params, still uses the range but with\na default value of not provided one:\n- Providing just `start_time` assumes `end_time` as far in the future,\n- Providing just `end_time` assumes `start_time` as far in the past.\n- Not providing `start_time` nor `end_time` results in `start_time` being\n  far in the past and `end_time` being far in the future and as a result\n  all events are returned by time range filter.\n\nBelow are few examples to better understand the logic:\n\n**Maintenance example**\n\nLet's assume maintenance that started on 2025-02-01 and finished\non 2025-02-08.\n\nUsing `start_time=2025-01-01T00:00:00Z` and `end_time=2025-02-02T00:00:00Z`\nwill return the event because there is an overlap of both ranges:<br>\n<2025-01-01 00:00:00 UTC, 2025-02-02 00:00:00 UTC> and<br>\n<2025-02-01 00:00:00 UTC, 2025-02-08 00:00:00 UTC> overlap in<br>\n<2025-02-01 00:00:00 UTC, 2025-02-02 00:00:00 UTC>.\n\n**Open incident example**\n\nLet's assume incident that started on 2025-02-01 and hasn't been\nresolved.<br>\n\nUsing `start_time=2025-03-01T00:00:00Z` and not providing end time\nwill return the event because there is an overlap of both ranges:<br>\n<2025-02-01 00:00:00 UTC, far in the future due to incident still being open>\nand<br>\n<2025-03-01 00:00:00 UTC, far in the future due to not providing `end_time`>\noverlap in<br>\n<2025-03-01 00:00:00 UTC, far in the future>.\n\n## Extended properties\n\nStatusHub API V3 supports extended versions of certain response properties.\nBy default less frequently required fields are returned in basic form\nwith most common properties but if more information is needed `extend`\nquery parameter can be used.<br>\nCurrently StatusHub API V3 supports extending:\n- Incident flags,\n- Incident Update flags,\n- Maintenance event flags,\n- Subscription flags.\n<br>\n<br>\nExample for Maintenance flags:\n- Request path with basic flags: `/api/v3/hubs/hub-subdomain/maintenances`,\n- Request path with extended flags:\n  `/api/v3/hubs/hub-subdomain/maintenances?extend=flags`\n"}},"baseSlug":"/api-v3-openapi","routesMapping":{}}