Instatus (Editora Independente) (Visualização)
Obtenha uma página de status resiliente ao tempo de inatividade e rápida de carregar. Sua página de status é estática e carrega independentemente de qualquer back-end.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troia Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Editora | Troia Taylor |
| Sítio Web | https://instatus.com/ |
| Política de privacidade | https://instatus.com/policies/privacy |
| Categorias | Website;Operações de TI |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave API (no formato 'Bearer API_Key') | securestring | A chave API (no formato 'Bearer API_Key') para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar atualização de incidente |
Adicione uma atualização a um incidente de página. |
| Adicionar atualização de manutenção |
Adicione uma atualização a uma manutenção em uma página. |
| Adicionar incidente |
Adiciona um incidente em uma página. |
| Adicionar incidente usando modelo |
Adiciona um incidente a uma página usando um modelo. |
| Adicionar manutenção |
Adicione uma manutenção a uma página. |
| Adicionar membro da equipa |
Adicione um membro à sua equipa numa página. |
| Adicionar modelo |
Crie um modelo para uma página. |
| Adicionar subscritor |
Adicione um subscritor a uma página. |
| Atualizar modelo |
Atualiza um modelo para uma página. |
| Componente de atualização |
Atualiza um componente em uma página. |
| Criar componente |
Cria um componente em uma página. |
| Criar página de estado |
Crie uma nova página de status com base nos parâmetros solicitados. |
| Editar atualização de incidente |
Edita uma atualização para um incidente em uma página. |
| Editar atualização de manutenção |
Edite uma atualização para uma manutenção em uma página. |
| Excluir atualização de incidente |
Exclui uma atualização para um incidente em uma página. |
| Excluir atualização de manutenção |
Excluir uma atualização para uma manutenção em uma página. |
| Excluir componente |
Exclui um componente em uma página. |
| Excluir incidente |
Exclui um incidente em uma página. |
| Excluir manutenção |
Exclui uma manutenção de uma página. |
| Excluir membro da equipe |
Exclui um membro da equipe de uma página. |
| Excluir modelo |
Exclui um modelo para uma página. |
| Excluir página de status |
Exclui uma página de status. |
| Incidente de atualização |
Atualiza um incidente em uma página. |
| Manutenção de atualizações |
Atualiza uma manutenção em uma página. |
| Obter atualização de incidentes |
Recuperar uma atualização em um incidente de página. |
| Obter atualização de manutenção |
Recuperar uma atualização para uma manutenção em uma página. |
| Obter companheiros de equipa |
Recupere uma lista de colegas de equipe. |
| Obter componente |
Recuperar um componente em uma página. |
| Obter componentes da página de status |
Recupere uma lista de todos os componentes da página de status. |
| Obter incidente |
Recuperar um incidente em uma página. |
| Obter incidentes de página |
Recupere todos os incidentes de uma página. |
| Obter manutenção |
Recupere uma manutenção para uma página. |
| Obter manutenções de página |
Recupere todas as manutenções de uma página. |
| Obter modelo |
Recuperar um modelo para uma página. |
| Obter modelos de página |
Recupere uma lista de todos os modelos de página. |
| Obter páginas de estado |
Recupere uma lista de suas páginas de status. |
| Obter subscritores |
Recupere uma lista de assinantes de uma página. |
| Página de status da atualização |
Atualize uma página de status criada. |
| Remover subscritor |
Remova um assinante de uma página. |
| Resolver incidente com modelo |
Resolve um incidente em uma página com um modelo. |
Adicionar atualização de incidente
Adicione uma atualização a um incidente de página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do incidente
|
incident_id | True | string |
O identificador de incidente. |
|
Message
|
message | string |
A mensagem. |
|
|
Components
|
components | array of string |
Os componentes. |
|
|
Started
|
started | string |
Quando iniciado. |
|
|
Situação
|
status | string |
O status. |
|
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
|
ID
|
id | string |
O identificador. |
|
|
Situação
|
status | string |
O status. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Message
|
message | string |
A mensagem. |
|
Mensagem HTML
|
messageHtml | string |
A mensagem HTML. |
|
Situação
|
status | string |
O status. |
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
Started
|
started | string |
Quando iniciado. |
|
ID
|
incident.id | string |
O identificador. |
|
Nome
|
incident.name | string |
O nome. |
|
Started
|
incident.started | string |
Quando iniciado. |
|
Situação
|
incident.status | string |
O status. |
|
Components
|
incident.components | array of object | |
|
ID
|
incident.components.id | string |
O identificador. |
|
Nome
|
incident.components.name | string |
O nome. |
|
Situação
|
incident.components.status | string |
O status. |
|
Mostrar tempo de atividade
|
incident.components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
Subdomain
|
incident.components.site.subdomain | string |
O subdomínio. |
|
URL do logótipo
|
incident.components.site.logoUrl | string |
O endereço URL do logotipo. |
|
Nome
|
incident.components.site.name | string |
O nome. |
|
Integrações do Slack
|
incident.components.site.slackIntegrations | array of string |
As integrações do Slack. |
|
Subscribers
|
incident.components.site.subscribers | array of string |
Os assinantes. |
|
Subscribers
|
incident.components.subscribers | array of string |
Os assinantes. |
Adicionar atualização de manutenção
Adicione uma atualização a uma manutenção em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID de manutenção
|
maintenance_id | True | string |
O identificador de manutenção. |
|
Message
|
message | string |
A mensagem. |
|
|
Components
|
components | array of string |
Os componentes. |
|
|
Started
|
started | string |
Quando iniciado. |
|
|
Fim
|
end | string |
Fim. |
|
|
Situação
|
status | string |
O status. |
|
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
|
ID
|
id | string |
O identificador. |
|
|
Situação
|
status | string |
O status. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Message
|
message | string |
A mensagem. |
|
Mensagem HTML
|
messageHtml | string |
A mensagem HTML. |
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
Started
|
started | string |
Quando iniciado. |
|
Situação
|
status | string |
O status. |
|
ID
|
maintenance.id | string |
O identificador. |
|
Nome
|
maintenance.name | string |
O nome. |
|
Start
|
maintenance.start | string |
O início. |
|
Situação
|
maintenance.status | string |
O status. |
|
Components
|
maintenance.components | array of object | |
|
ID
|
maintenance.components.id | string |
O identificador. |
|
Nome
|
maintenance.components.name | string |
O nome. |
|
Situação
|
maintenance.components.status | string |
O status. |
|
Mostrar tempo de atividade
|
maintenance.components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
Subscribers
|
maintenance.components.subscribers | array of string |
Os assinantes. |
|
ID
|
maintenance.components.site.id | string |
O identificador. |
|
Nome
|
maintenance.components.site.name | string |
O nome. |
|
Subdomain
|
maintenance.components.site.subdomain | string |
O subdomínio. |
|
Cor
|
maintenance.components.site.color | string |
A cor. |
|
URL do logótipo
|
maintenance.components.site.logoUrl | string |
O endereço URL do logotipo. |
|
E-mail público
|
maintenance.components.site.publicEmail | string |
O endereço de e-mail público. |
|
Subscribers
|
maintenance.components.site.subscribers | array of string |
Os assinantes. |
Adicionar incidente
Adiciona um incidente em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
Nome
|
name | string |
O nome. |
|
|
Message
|
message | string |
A mensagem. |
|
|
Components
|
components | array of string |
Os componentes. |
|
|
Started
|
started | string |
Quando iniciado. |
|
|
Situação
|
status | string |
O status. |
|
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
|
ID
|
id | string |
O identificador. |
|
|
Situação
|
status | string |
O status. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Situação
|
status | string |
O status. |
|
Started
|
started | string |
Quando iniciado. |
|
Resolvido
|
resolved | string |
Quando resolvido. |
|
Atualizações
|
updates | array of string |
As atualizações. |
|
Components
|
components | array of object | |
|
ID
|
components.id | string |
O identificador. |
|
Nome
|
components.name | string |
O nome. |
|
Situação
|
components.status | string |
O status. |
|
Mostrar tempo de atividade
|
components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
ID
|
components.site.id | string |
O identificador. |
|
Nome
|
components.site.name | string |
O nome. |
|
Subdomain
|
components.site.subdomain | string |
O subdomínio. |
|
Cor
|
components.site.color | string |
A cor. |
|
URL do logótipo
|
components.site.logoUrl | string |
O endereço URL do logotipo. |
|
E-mail público
|
components.site.publicEmail | string |
O endereço de e-mail público. |
Adicionar incidente usando modelo
Adiciona um incidente a uma página usando um modelo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
Template
|
template | True | string |
O modelo. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Nome ID de tradução
|
nameTranslationId | string |
O identificador de tradução de nomes. |
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
Situação
|
status | string |
O status. |
|
Started
|
started | string |
Quando iniciado. |
|
Resolvido
|
resolved | string |
Quando resolvido. |
|
Duração
|
duration | string |
A duração. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
Automatizado
|
automated | boolean |
Se automatizado. |
|
Impacto
|
impact | string |
O impacto. |
|
ID de Aplicação
|
appId | string |
O identificador do aplicativo. |
|
ID do Site
|
siteId | string |
O identificador do site. |
|
Importado da página de status
|
importedFromStatuspage | boolean |
Se importado da página de status. |
Adicionar manutenção
Adicione uma manutenção a uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
Nome
|
name | string |
O nome. |
|
|
Message
|
message | string |
A mensagem. |
|
|
Components
|
components | array of string |
Os componentes. |
|
|
Start
|
start | string |
O início. |
|
|
Fim
|
end | string |
Fim. |
|
|
Situação
|
status | string |
O status. |
|
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
|
Duração
|
duration | integer |
A duração. |
|
|
Notificar Início
|
notifyStart | boolean |
Se deve notificar o início. |
|
|
Notificar Fim
|
notifyEnd | boolean |
Se a notificação deve terminar. |
|
|
Notificar com antecedência
|
notifyEarly | boolean |
Se deve notificar antecipadamente. |
|
|
Notificar Atas
|
notifyMinutes | integer |
A ata de notificação. |
|
|
Arranque automático
|
autoStart | boolean |
Se deve iniciar automaticamente. |
|
|
Fim automático
|
autoEnd | boolean |
Se o fim automático deve ser feito. |
|
|
ID
|
id | string |
O identificador. |
|
|
Situação
|
status | string |
O status. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Duração
|
duration | string |
A duração. |
|
Start
|
start | string |
O início. |
|
Fim
|
end | string |
Fim. |
|
Situação
|
status | string |
O status. |
|
Atualizações
|
updates | array of string |
As atualizações. |
|
Components
|
components | array of object | |
|
ID
|
components.id | string |
O identificador. |
|
Nome
|
components.name | string |
O nome. |
|
Situação
|
components.status | string |
O status. |
|
Mostrar tempo de atividade
|
components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
ID
|
components.site.id | string |
O identificador. |
|
Nome
|
components.site.name | string |
O nome. |
|
Subdomain
|
components.site.subdomain | string |
O subdomínio. |
|
Cor
|
components.site.color | string |
A cor. |
|
URL do logótipo
|
components.site.logoUrl | string |
O endereço URL do logotipo. |
|
E-mail público
|
components.site.publicEmail | string |
O endereço de e-mail público. |
Adicionar membro da equipa
Adicione um membro à sua equipa numa página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
Email
|
string |
O endereço de e-mail. |
Devoluções
- response
- string
Adicionar modelo
Crie um modelo para uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
Subdomain
|
subdomain | string |
O subdomínio. |
|
|
Tipo
|
type | string |
O tipo. |
|
|
Nome
|
name | string |
O nome. |
|
|
Message
|
message | string |
A mensagem. |
|
|
Situação
|
status | string |
O status. |
|
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
|
ID
|
id | string |
O identificador. |
|
|
Situação
|
status | string |
O status. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Tipo
|
type | string |
O tipo. |
|
Nome
|
name | string |
O nome. |
|
Nome ID de tradução
|
nameTranslationId | string |
O identificador de tradução de nomes. |
|
Message
|
message | string |
A mensagem. |
|
ID de tradução de mensagem
|
messageTranslationId | string |
O identificador de tradução de mensagens. |
|
Mensagem HTML
|
messageHtml | string |
A mensagem HTML. |
|
ID de tradução HTML da mensagem
|
messageHtmlTranslationId | string |
O identificador de tradução HTML da mensagem. |
|
Situação
|
status | string |
O status. |
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID do Site
|
siteId | string |
O identificador do site. |
|
Importado da página de status
|
importedFromStatuspage | boolean |
Se importado da página de status. |
|
Suprimido em
|
deletedAt | string |
Quando excluído em. |
|
Components
|
components | array of string |
Os componentes. |
|
Nome
|
translations.name | string |
O nome. |
|
Message
|
translations.message | string |
A mensagem. |
Adicionar subscritor
Adicione um subscritor a uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
Email
|
string |
O endereço de e-mail. |
||
|
Todos
|
all | boolean |
Se todos. |
|
|
Confirmação automática
|
autoConfirm | boolean |
Se a confirmação automática deve ou não. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Email
|
string |
O endereço de e-mail. |
|
|
ID
|
site.id | string |
O identificador. |
|
Nome
|
site.name | string |
O nome. |
|
URL do logótipo
|
site.logoUrl | string |
O endereço URL do logotipo. |
|
Subdomain
|
site.subdomain | string |
O subdomínio. |
|
E-mail público
|
site.publicEmail | string |
O endereço de e-mail público. |
|
Linguagem
|
site.language | string |
A língua. |
Atualizar modelo
Atualiza um modelo para uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do modelo
|
template_id | True | string |
O identificador do modelo. |
|
Tipo
|
type | string |
O tipo. |
|
|
Nome
|
name | string |
O nome. |
|
|
Message
|
message | string |
A mensagem. |
|
|
Situação
|
status | string |
O status. |
|
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
|
ID
|
id | string |
O identificador. |
|
|
Situação
|
status | string |
O status. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Tipo
|
type | string |
O tipo. |
|
Nome
|
name | string |
O nome. |
|
Nome ID de tradução
|
nameTranslationId | string |
O identificador de tradução de nomes. |
|
Message
|
message | string |
A mensagem. |
|
ID de tradução de mensagem
|
messageTranslationId | string |
O identificador de tradução de mensagens. |
|
Mensagem HTML
|
messageHtml | string |
A mensagem HTML. |
|
ID de tradução HTML da mensagem
|
messageHtmlTranslationId | string |
O identificador de tradução HTML da mensagem. |
|
Situação
|
status | string |
O status. |
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID do Site
|
siteId | string |
O identificador do site. |
|
Importado da página de status
|
importedFromStatuspage | boolean |
Se importado da página de status. |
|
Suprimido em
|
deletedAt | string |
Quando excluído em. |
|
Components
|
components | array of object | |
|
ID
|
components.id | string |
O identificador. |
|
Situação
|
components.status | string |
O status. |
|
ID do componente
|
components.componentId | string |
O identificador do componente. |
|
ID do modelo
|
components.templateId | string |
O identificador do modelo. |
|
Importado da página de status
|
components.importedFromStatuspage | boolean |
Se importado da página de status. |
|
Nome
|
translations.name | string |
O nome. |
|
Message
|
translations.message | string |
A mensagem. |
Componente de atualização
Atualiza um componente em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do componente
|
component_id | True | string |
O identificador do componente. |
|
Nome
|
name | string |
O nome. |
|
|
Description
|
description | string |
A descrição. |
|
|
Situação
|
status | string |
O status. |
|
|
Encomenda
|
order | integer |
A ordem. |
|
|
Mostrar tempo de atividade
|
showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
|
Agrupados
|
grouped | boolean |
Se agrupado. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
E-mail exclusivo
|
uniqueEmail | string |
O endereço de e-mail exclusivo. |
|
Situação
|
status | string |
O status. |
|
Description
|
description | string |
A descrição. |
|
Mostrar tempo de atividade
|
showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
Encomenda
|
order | integer |
A ordem. |
|
Grupo
|
group | string |
O grupo. |
Criar componente
Cria um componente em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
Nome
|
name | string |
O nome. |
|
|
Description
|
description | string |
A descrição. |
|
|
Situação
|
status | string |
O status. |
|
|
Encomenda
|
order | integer |
A ordem. |
|
|
Mostrar tempo de atividade
|
showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
|
Agrupados
|
grouped | boolean |
Se agrupado. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Description
|
description | string |
A descrição. |
|
E-mail exclusivo
|
uniqueEmail | string |
O endereço de e-mail exclusivo. |
|
Situação
|
status | string |
O status. |
|
Mostrar tempo de atividade
|
showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
Encomenda
|
order | integer |
A ordem. |
|
Grupo
|
group | string |
O grupo. |
Criar página de estado
Crie uma nova página de status com base nos parâmetros solicitados.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Email
|
string |
O endereço de e-mail. |
||
|
Nome
|
name | string |
O nome. |
|
|
Subdomain
|
subdomain | string |
O subdomínio. |
|
|
Components
|
components | array of string |
Os componentes. |
|
|
URL do logótipo
|
logoUrl | string |
O endereço URL do logotipo. |
|
|
Favicon URL
|
faviconUrl | string |
O endereço URL favicon. |
|
|
URL do site
|
websiteUrl | string |
O endereço URL do site. |
|
|
Linguagem
|
language | string |
A língua. |
|
|
Usar cabeçalho grande
|
useLargeHeader | boolean |
Se deve usar um cabeçalho grande. |
|
|
Cor da Marca
|
brandColor | string |
A cor da marca. |
|
|
OK Cor
|
okColor | string |
A cor OK. |
|
|
Cor interrompida
|
disruptedColor | string |
A cor interrompida. |
|
|
Cor degradada
|
degradedColor | string |
A cor degradada. |
|
|
Cor para baixo
|
downColor | string |
A cor para baixo. |
|
|
Cor do aviso
|
noticeColor | string |
A cor do aviso. |
|
|
Cor desconhecida
|
unknownColor | string |
A cor desconhecida. |
|
|
Google Analytics
|
googleAnalytics | string |
O Google Analytics. |
|
|
Subscrever por SMS
|
subscribeBySms | boolean |
Se pretende subscrever por SMS. |
|
|
Serviço de SMS
|
smsService | string |
O serviço de SMS. |
|
|
Twilio SID
|
twilioSid | string |
O SID Twilio. |
|
|
Twilio Token
|
twilioToken | string |
O token Twilio. |
|
|
Twilio Remetente
|
twilioSender | string |
O remetente Twilio. |
|
|
HTML em Meta
|
htmlInMeta | string |
O HTML no meta. |
|
|
HTML acima do cabeçalho
|
htmlAboveHeader | string |
O cabeçalho HTML acima. |
|
|
HTML abaixo do cabeçalho
|
htmlBelowHeader | string |
O cabeçalho HTML abaixo. |
|
|
HTML acima do rodapé
|
htmlAboveFooter | string |
O rodapé HTML acima. |
|
|
HTML abaixo do rodapé
|
htmlBelowFooter | string |
O HTML abaixo do rodapé. |
|
|
HTML abaixo Resumo
|
htmlBelowSummary | string |
O HTML abaixo resume. |
|
|
CSS Global
|
cssGlobal | string |
O CSS global. |
|
|
Data de Lançamento
|
launchDate | string |
A data de lançamento. |
|
|
Formato de data
|
dateFormat | string |
O formato de data. |
|
|
Formato de Data Curto
|
dateFormatShort | string |
O formato de data curto. |
|
|
Formato de hora
|
timeFormat | string |
O formato de hora. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
Subdomain
|
subdomain | string |
O subdomínio. |
|
URL do logótipo
|
logoUrl | string |
O endereço URL do logotipo. |
|
Favicon URL
|
faviconUrl | string |
O endereço URL favicon. |
|
URL do site
|
websiteUrl | string |
O endereço URL do site. |
|
Nome
|
name | string |
O nome. |
|
Situação
|
status | string |
O status. |
|
Cor
|
color | string |
A cor. |
|
Linguagem
|
language | string |
A língua. |
|
Google Analytics
|
googleAnalytics | string |
O Google Analytics. |
|
E-mail público
|
publicEmail | string |
O endereço de e-mail público. |
|
Custom Domain
|
customDomain | string |
O domínio personalizado. |
|
Usar cabeçalho grande
|
useLargeHeader | boolean |
Se deve usar um cabeçalho grande. |
|
Desativar o Modo Escuro
|
disableDarkMode | string |
O modo escuro desativado. |
|
Twitter
|
string |
O identificador do Twitter. |
|
|
Subscrever por SMS
|
subscribeBySms | string |
A subscrição por SMS. |
|
Cor da Marca
|
brandColor | string |
A cor da marca. |
|
OK Cor
|
okColor | string |
A cor OK. |
|
Cor interrompida
|
disruptedColor | string |
A cor interrompida. |
|
Cor para baixo
|
downColor | string |
A cor para baixo. |
|
Cor degradada
|
degradedColor | string |
A cor degradada. |
|
Cor do aviso
|
noticeColor | string |
A cor do aviso. |
|
HTML em Meta
|
htmlInMeta | string |
O HTML no meta. |
|
HTML acima do cabeçalho
|
htmlAboveHeader | string |
O cabeçalho HTML acima. |
|
HTML abaixo do cabeçalho
|
htmlBelowHeader | string |
O cabeçalho HTML abaixo. |
|
HTML acima do rodapé
|
htmlAboveFooter | string |
O rodapé HTML acima. |
|
HTML abaixo do rodapé
|
htmlBelowFooter | string |
O HTML abaixo do rodapé. |
|
HTML abaixo Resumo
|
htmlBelowSummary | string |
O HTML abaixo resume. |
|
CSS Global
|
cssGlobal | string |
O CSS global. |
|
A bordo
|
onboarded | string |
O embarcado. |
|
Data de Lançamento
|
launchDate | string |
A data de lançamento. |
|
Formato de data
|
dateFormat | string |
O formato de data. |
|
Formato de Data Curto
|
dateFormatShort | string |
O formato de data curto. |
|
Formato de hora
|
timeFormat | string |
O formato de hora. |
|
Privado
|
private | boolean |
Se privado. |
|
Usar a Lista de Permissões
|
useAllowList | boolean |
Se a lista de permissões deve ser usada. |
|
Lista de Permissões
|
allowList | array of string |
A lista de permissões. |
|
Components
|
components | array of object | |
|
ID
|
components.id | string |
O identificador. |
|
Nome
|
components.name | string |
O nome. |
|
Situação
|
components.status | string |
O status. |
|
Mostrar tempo de atividade
|
components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
Encomenda
|
components.order | string |
A ordem. |
|
Grupo
|
components.group | string |
O grupo. |
|
Incidentes
|
components.incidents | array of string |
Os incidentes. |
Editar atualização de incidente
Edita uma atualização para um incidente em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do incidente
|
incident_id | True | string |
O identificador de incidente. |
|
ID de atualização do incidente
|
incident_update_id | True | string |
O identificador de atualização de incidente. |
|
Message
|
message | string |
A mensagem. |
|
|
Components
|
components | array of string |
Os componentes. |
|
|
Started
|
started | string |
Quando iniciado. |
|
|
Situação
|
status | string |
O status. |
|
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
|
ID
|
id | string |
O identificador. |
|
|
Situação
|
status | string |
O status. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Message
|
message | string |
A mensagem. |
|
Mensagem HTML
|
messageHtml | string |
A mensagem HTML. |
|
Situação
|
status | string |
O status. |
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
Started
|
started | string |
Quando iniciado. |
|
ID
|
incident.id | string |
O identificador. |
|
Nome
|
incident.name | string |
O nome. |
|
Started
|
incident.started | string |
Quando iniciado. |
|
Situação
|
incident.status | string |
O status. |
|
Components
|
incident.components | array of object | |
|
ID
|
incident.components.id | string |
O identificador. |
|
Nome
|
incident.components.name | string |
O nome. |
|
Situação
|
incident.components.status | string |
O status. |
|
Mostrar tempo de atividade
|
incident.components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
Subdomain
|
incident.components.site.subdomain | string |
O subdomínio. |
|
URL do logótipo
|
incident.components.site.logoUrl | string |
O endereço URL do logotipo. |
|
Nome
|
incident.components.site.name | string |
O nome. |
|
Integrações do Slack
|
incident.components.site.slackIntegrations | array of string |
As integrações do Slack. |
|
Subscribers
|
incident.components.site.subscribers | array of string |
Os assinantes. |
|
Subscribers
|
incident.components.subscribers | array of string |
Os assinantes. |
Editar atualização de manutenção
Edite uma atualização para uma manutenção em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID de manutenção
|
maintenance_id | True | string |
O identificador de manutenção. |
|
ID da atualização de manutenção
|
maintenance_update_id | True | string |
O identificador de atualização de manutenção. |
|
Message
|
message | string |
A mensagem. |
|
|
Components
|
components | array of string |
Os componentes. |
|
|
Started
|
started | string |
Quando iniciado. |
|
|
Fim
|
end | string |
Fim. |
|
|
Situação
|
status | string |
O status. |
|
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
|
ID
|
id | string |
O identificador. |
|
|
Situação
|
status | string |
O status. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Message
|
message | string |
A mensagem. |
|
Mensagem HTML
|
messageHtml | string |
A mensagem HTML. |
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
Started
|
started | string |
Quando iniciado. |
|
Situação
|
status | string |
O status. |
|
ID
|
maintenance.id | string |
O identificador. |
|
Nome
|
maintenance.name | string |
O nome. |
|
Start
|
maintenance.start | string |
O início. |
|
Situação
|
maintenance.status | string |
O status. |
|
Components
|
maintenance.components | array of object | |
|
ID
|
maintenance.components.id | string |
O identificador. |
|
Nome
|
maintenance.components.name | string |
O nome. |
|
Situação
|
maintenance.components.status | string |
O status. |
|
Mostrar tempo de atividade
|
maintenance.components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
Subscritores
|
maintenance.components.subscribers | array of string |
Os assinantes. |
|
ID
|
maintenance.components.site.id | string |
O identificador. |
|
Nome
|
maintenance.components.site.name | string |
O nome. |
|
Subdomain
|
maintenance.components.site.subdomain | string |
O subdomínio. |
|
Cor
|
maintenance.components.site.color | string |
A cor. |
|
URL do logótipo
|
maintenance.components.site.logoUrl | string |
O endereço URL do logotipo. |
|
E-mail público
|
maintenance.components.site.publicEmail | string |
O endereço de e-mail público. |
|
Subscribers
|
maintenance.components.site.subscribers | array of string |
Os assinantes. |
Excluir atualização de incidente
Exclui uma atualização para um incidente em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do incidente
|
incident_id | True | string |
O identificador de incidente. |
|
ID de atualização do incidente
|
incident_update_id | True | string |
O identificador de atualização de incidente. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Excluir atualização de manutenção
Excluir uma atualização para uma manutenção em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID de manutenção
|
maintenance_id | True | string |
O identificador de manutenção. |
|
ID da atualização de manutenção
|
maintenance_update_id | True | string |
O identificador de atualização de manutenção. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Excluir componente
Exclui um componente em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do componente
|
component_id | True | string |
O identificador do componente. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Excluir incidente
Exclui um incidente em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do incidente
|
incident_id | True | string |
O identificador de incidente. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Excluir manutenção
Exclui uma manutenção de uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID de manutenção
|
maintenance_id | True | string |
O identificador de manutenção. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Excluir membro da equipe
Exclui um membro da equipe de uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID de Membro
|
member_id | True | string |
O identificador de membro. |
Devoluções
- response
- string
Excluir modelo
Exclui um modelo para uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do modelo
|
template_id | True | string |
O identificador do modelo. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Message
|
message | string |
A mensagem. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID
|
site.id | string |
O identificador. |
Excluir página de status
Exclui uma página de status.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
Incidente de atualização
Atualiza um incidente em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do incidente
|
incident_id | True | string |
O identificador de incidente. |
|
Nome
|
name | string |
O nome. |
|
|
Components
|
components | array of string |
Os componentes. |
|
|
Started
|
started | string |
Quando iniciado. |
|
|
Situação
|
status | string |
O status. |
|
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
|
ID
|
id | string |
O identificador. |
|
|
Situação
|
status | string |
O status. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Situação
|
status | string |
O status. |
|
Started
|
started | string |
Quando iniciado. |
|
Resolvido
|
resolved | string |
Quando resolvido. |
|
Atualizações
|
updates | array of string |
As atualizações. |
|
Components
|
components | array of object | |
|
ID
|
components.id | string |
O identificador. |
|
Nome
|
components.name | string |
O nome. |
|
Situação
|
components.status | string |
O status. |
|
Mostrar tempo de atividade
|
components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
ID
|
components.site.id | string |
O identificador. |
|
Nome
|
components.site.name | string |
O nome. |
|
Subdomain
|
components.site.subdomain | string |
O subdomínio. |
|
Cor
|
components.site.color | string |
A cor. |
|
URL do logótipo
|
components.site.logoUrl | string |
O endereço URL do logotipo. |
|
E-mail público
|
components.site.publicEmail | string |
O endereço de e-mail público. |
Manutenção de atualizações
Atualiza uma manutenção em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID de manutenção
|
maintenance_id | True | string |
O identificador de manutenção. |
|
Nome
|
name | string |
O nome. |
|
|
Message
|
message | string |
A mensagem. |
|
|
Components
|
components | array of string |
Os componentes. |
|
|
Start
|
start | string |
O início. |
|
|
Fim
|
end | string |
Fim. |
|
|
Situação
|
status | string |
O status. |
|
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
|
ID
|
id | string |
O identificador. |
|
|
Situação
|
status | string |
O status. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Situação
|
status | string |
O status. |
|
Start
|
start | string |
O início. |
|
Duração
|
duration | string |
A duração. |
|
Atualizações
|
updates | array of object | |
|
ID
|
updates.id | string |
O identificador. |
|
Message
|
updates.message | string |
A mensagem. |
|
Mensagem HTML
|
updates.messageHtml | string |
A mensagem HTML. |
|
Situação
|
updates.status | string |
O status. |
|
Notificar
|
updates.notify | boolean |
Se deve notificar. |
|
Started
|
updates.started | string |
Quando iniciado. |
|
Ended
|
updates.ended | string |
Quando terminou. |
|
Duração
|
updates.duration | string |
A duração. |
|
Criado em
|
updates.createdAt | string |
Quando criado em. |
|
Components
|
components | array of object | |
|
ID
|
components.id | string |
O identificador. |
|
Nome
|
components.name | string |
O nome. |
|
Situação
|
components.status | string |
O status. |
|
Mostrar tempo de atividade
|
components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
ID
|
components.site.id | string |
O identificador. |
|
Nome
|
components.site.name | string |
O nome. |
|
Subdomain
|
components.site.subdomain | string |
O subdomínio. |
|
Cor
|
components.site.color | string |
A cor. |
|
URL do logótipo
|
components.site.logoUrl | string |
O endereço URL do logotipo. |
|
E-mail público
|
components.site.publicEmail | string |
O endereço de e-mail público. |
Obter atualização de incidentes
Recuperar uma atualização em um incidente de página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do incidente
|
incident_id | True | string |
O identificador de incidente. |
|
ID de atualização do incidente
|
incident_update_id | True | string |
O identificador de atualização de incidente. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Message
|
message | string |
A mensagem. |
|
Mensagem HTML
|
messageHtml | string |
A mensagem HTML. |
|
Situação
|
status | string |
O status. |
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
Started
|
started | string |
Quando iniciado. |
|
ID
|
incident.id | string |
O identificador. |
|
Nome
|
incident.name | string |
O nome. |
|
Started
|
incident.started | string |
Quando iniciado. |
|
Situação
|
incident.status | string |
O status. |
|
Components
|
incident.components | array of object | |
|
ID
|
incident.components.id | string |
O identificador. |
|
Nome
|
incident.components.name | string |
O nome. |
|
Situação
|
incident.components.status | string |
O status. |
|
Mostrar tempo de atividade
|
incident.components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
Subdomain
|
incident.components.site.subdomain | string |
O subdomínio. |
|
URL do logótipo
|
incident.components.site.logoUrl | string |
O endereço URL do logotipo. |
|
Nome
|
incident.components.site.name | string |
O nome. |
|
Integrações do Slack
|
incident.components.site.slackIntegrations | array of string |
As integrações do Slack. |
|
Subscribers
|
incident.components.site.subscribers | array of string |
Os assinantes. |
|
Subscribers
|
incident.components.subscribers | array of string |
Os assinantes. |
Obter atualização de manutenção
Recuperar uma atualização para uma manutenção em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID de manutenção
|
maintenance_id | True | string |
O identificador de manutenção. |
|
ID da atualização de manutenção
|
maintenance_update_id | True | string |
O identificador de atualização de manutenção. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Message
|
message | string |
A mensagem. |
|
Mensagem HTML
|
messageHtml | string |
A mensagem HTML. |
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
Started
|
started | string |
Quando iniciado. |
|
Situação
|
status | string |
O status. |
|
ID
|
maintenance.id | string |
O identificador. |
|
Nome
|
maintenance.name | string |
O nome. |
|
Start
|
maintenance.start | string |
O início. |
|
Situação
|
maintenance.status | string |
O status. |
|
Components
|
maintenance.components | array of object | |
|
ID
|
maintenance.components.id | string |
O identificador. |
|
Nome
|
maintenance.components.name | string |
O nome. |
|
Situação
|
maintenance.components.status | string |
O status. |
|
Mostrar tempo de atividade
|
maintenance.components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
ID
|
maintenance.components.site.id | string |
O identificador. |
|
Nome
|
maintenance.components.site.name | string |
O nome. |
|
Subdomain
|
maintenance.components.site.subdomain | string |
O subdomínio. |
|
Cor
|
maintenance.components.site.color | string |
A cor. |
|
URL do logótipo
|
maintenance.components.site.logoUrl | string |
O endereço URL do logotipo. |
|
E-mail público
|
maintenance.components.site.publicEmail | string |
O endereço de e-mail público. |
Obter companheiros de equipa
Recupere uma lista de colegas de equipe.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
Página
|
page | integer |
A página. |
|
|
Número por Página
|
per_page | integer |
O número por página. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
id | string |
O identificador. |
|
ID
|
user.id | string |
O identificador. |
|
Nome
|
user.name | string |
O nome. |
|
Email
|
user.email | string |
O endereço de e-mail. |
|
Avatar
|
user.avatar | string |
O avatar. |
Obter componente
Recuperar um componente em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do componente
|
component_id | True | string |
O identificador do componente. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Description
|
description | string |
A descrição. |
|
Situação
|
status | string |
O status. |
|
E-mail exclusivo
|
uniqueEmail | string |
O endereço de e-mail exclusivo. |
|
Mostrar tempo de atividade
|
showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
Encomenda
|
order | integer |
A ordem. |
|
Grupo
|
group | string |
O grupo. |
Obter componentes da página de status
Recupere uma lista de todos os componentes da página de status.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
Página
|
page | integer |
A página. |
|
|
Número por Página
|
per_page | integer |
O número por página. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Situação
|
status | string |
O status. |
|
E-mail exclusivo
|
uniqueEmail | string |
O endereço de e-mail exclusivo. |
|
Description
|
description | string |
A descrição. |
|
Mostrar tempo de atividade
|
showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
Encomenda
|
order | integer |
A ordem. |
|
Grupo
|
group | string |
O grupo. |
Obter incidente
Recuperar um incidente em uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do incidente
|
incident_id | True | string |
O identificador de incidente. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Situação
|
status | string |
O status. |
|
Started
|
started | string |
Quando iniciado. |
|
Resolvido
|
resolved | string |
Quando resolvido. |
|
Atualizações
|
updates | array of object | |
|
ID
|
updates.id | string |
O identificador. |
|
Message
|
updates.message | string |
A mensagem. |
|
Mensagem HTML
|
updates.messageHtml | string |
A mensagem HTML. |
|
Situação
|
updates.status | string |
O status. |
|
Notificar
|
updates.notify | boolean |
Se deve notificar. |
|
Started
|
updates.started | string |
Quando iniciado. |
|
Ended
|
updates.ended | string |
Quando terminou. |
|
Duração
|
updates.duration | string |
A duração. |
|
Criado em
|
updates.createdAt | string |
Quando criado em. |
|
Components
|
components | array of object | |
|
ID
|
components.id | string |
O identificador. |
|
Nome
|
components.name | string |
O nome. |
|
Situação
|
components.status | string |
O status. |
|
Mostrar tempo de atividade
|
components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
ID
|
components.site.id | string |
O identificador. |
|
Nome
|
components.site.name | string |
O nome. |
|
Subdomain
|
components.site.subdomain | string |
O subdomínio. |
|
Cor
|
components.site.color | string |
A cor. |
|
URL do logótipo
|
components.site.logoUrl | string |
O endereço URL do logotipo. |
|
E-mail público
|
components.site.publicEmail | string |
O endereço de e-mail público. |
Obter incidentes de página
Recupere todos os incidentes de uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
Situação
|
status | string |
O status. |
|
|
Página
|
page | integer |
A página. |
|
|
Número por Página
|
per_page | integer |
O número por página. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Started
|
started | string |
Quando iniciado. |
|
Situação
|
status | string |
O status. |
|
Resolvido
|
resolved | string |
Quando resolvido. |
|
Atualizações
|
updates | array of object | |
|
ID
|
updates.id | string |
O identificador. |
|
Message
|
updates.message | string |
A mensagem. |
|
Mensagem HTML
|
updates.messageHtml | string |
A mensagem HTML. |
|
Situação
|
updates.status | string |
O status. |
|
Notificar
|
updates.notify | boolean |
Se deve notificar. |
|
Started
|
updates.started | string |
Quando iniciado. |
|
Ended
|
updates.ended | string |
Quando terminou. |
|
Duração
|
updates.duration | string |
A duração. |
|
Criado em
|
updates.createdAt | string |
Quando criado em. |
|
Components
|
components | array of object | |
|
ID
|
components.id | string |
O identificador. |
|
Nome
|
components.name | string |
O nome. |
|
Situação
|
components.status | string |
O status. |
|
Mostrar tempo de atividade
|
components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
ID
|
components.site.id | string |
O identificador. |
|
Nome
|
components.site.name | string |
O nome. |
|
Subdomain
|
components.site.subdomain | string |
O subdomínio. |
|
Cor
|
components.site.color | string |
A cor. |
|
URL do logótipo
|
components.site.logoUrl | string |
O endereço URL do logotipo. |
|
E-mail público
|
components.site.publicEmail | string |
O endereço de e-mail público. |
Obter manutenção
Recupere uma manutenção para uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID de manutenção
|
maintenance_id | True | string |
O identificador de manutenção. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Situação
|
status | string |
O status. |
|
Start
|
start | string |
O início. |
|
Duração
|
duration | integer |
A duração. |
|
Notificar Início
|
notifyStart | boolean |
Se deve notificar o início. |
|
Notificar Fim
|
notifyEnd | boolean |
Se a notificação deve terminar. |
|
Notificar com antecedência
|
notifyEarly | boolean |
Se deve notificar antecipadamente. |
|
Notificar Atas
|
notifyMinutes | integer |
A ata de notificação. |
|
Arranque automático
|
autoStart | boolean |
Se deve iniciar automaticamente. |
|
Fim automático
|
autoEnd | boolean |
Se o fim automático deve ser feito. |
|
Atualizações
|
updates | array of object | |
|
ID
|
updates.id | string |
O identificador. |
|
Message
|
updates.message | string |
A mensagem. |
|
Mensagem HTML
|
updates.messageHtml | string |
A mensagem HTML. |
|
Situação
|
updates.status | string |
O status. |
|
Notificar
|
updates.notify | boolean |
Se deve notificar. |
|
Started
|
updates.started | string |
Quando iniciado. |
|
Ended
|
updates.ended | string |
Quando terminou. |
|
Duração
|
updates.duration | string |
A duração. |
|
Criado em
|
updates.createdAt | string |
Quando criado em. |
|
Components
|
components | array of object | |
|
ID
|
components.id | string |
O identificador. |
|
Nome
|
components.name | string |
O nome. |
|
Situação
|
components.status | string |
O status. |
|
Mostrar tempo de atividade
|
components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
ID
|
components.site.id | string |
O identificador. |
|
Nome
|
components.site.name | string |
O nome. |
|
Subdomain
|
components.site.subdomain | string |
O subdomínio. |
|
Cor
|
components.site.color | string |
A cor. |
|
URL do logótipo
|
components.site.logoUrl | string |
O endereço URL do logotipo. |
|
E-mail público
|
components.site.publicEmail | string |
O endereço de e-mail público. |
Obter manutenções de página
Recupere todas as manutenções de uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
Página
|
page | integer |
A página. |
|
|
Número por Página
|
per_page | integer |
O número por página. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
id | string |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Situação
|
status | string |
O status. |
|
Start
|
start | string |
O início. |
|
Duração
|
duration | integer |
A duração. |
|
Notificar Início
|
notifyStart | boolean |
Se deve notificar o início. |
|
Notificar Fim
|
notifyEnd | boolean |
Se a notificação deve terminar. |
|
Notificar com antecedência
|
notifyEarly | boolean |
Se deve notificar antecipadamente. |
|
Notificar Atas
|
notifyMinutes | integer |
A ata de notificação. |
|
Arranque automático
|
autoStart | boolean |
Se deve iniciar automaticamente. |
|
Fim automático
|
autoEnd | boolean |
Se o fim automático deve ser feito. |
|
Atualizações
|
updates | array of object | |
|
ID
|
updates.id | string |
O identificador. |
|
Message
|
updates.message | string |
A mensagem. |
|
Mensagem HTML
|
updates.messageHtml | string |
A mensagem HTML. |
|
Situação
|
updates.status | string |
O status. |
|
Notificar
|
updates.notify | boolean |
Se deve notificar. |
|
Started
|
updates.started | string |
Quando iniciado. |
|
Ended
|
updates.ended | string |
Quando terminou. |
|
Duração
|
updates.duration | string |
A duração. |
|
Criado em
|
updates.createdAt | string |
Quando criado em. |
|
Components
|
components | array of object | |
|
ID
|
components.id | string |
O identificador. |
|
Nome
|
components.name | string |
O nome. |
|
Situação
|
components.status | string |
O status. |
|
Mostrar tempo de atividade
|
components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
ID
|
components.site.id | string |
O identificador. |
|
Nome
|
components.site.name | string |
O nome. |
|
Subdomain
|
components.site.subdomain | string |
O subdomínio. |
|
Cor
|
components.site.color | string |
A cor. |
|
URL do logótipo
|
components.site.logoUrl | string |
O endereço URL do logotipo. |
|
E-mail público
|
components.site.publicEmail | string |
O endereço de e-mail público. |
Obter modelo
Recuperar um modelo para uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do modelo
|
template_id | True | string |
O identificador do modelo. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Tipo
|
type | string |
O tipo. |
|
Nome
|
name | string |
O nome. |
|
Nome ID de tradução
|
nameTranslationId | string |
O identificador de tradução de nomes. |
|
Message
|
message | string |
A mensagem. |
|
ID de tradução de mensagem
|
messageTranslationId | string |
O identificador de tradução de mensagens. |
|
Mensagem HTML
|
messageHtml | string |
A mensagem HTML. |
|
ID de tradução HTML da mensagem
|
messageHtmlTranslationId | string |
O identificador de tradução HTML da mensagem. |
|
Situação
|
status | string |
O status. |
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID do Site
|
siteId | string |
O identificador do site. |
|
Importado da página de status
|
importedFromStatuspage | boolean |
Se importado da página de status. |
|
Suprimido em
|
deletedAt | string |
Quando excluído em. |
|
Components
|
components | array of string |
Os componentes. |
|
Nome
|
translations.name | string |
O nome. |
|
Message
|
translations.message | string |
A mensagem. |
Obter modelos de página
Recupere uma lista de todos os modelos de página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
Página
|
page | integer |
A página. |
|
|
Número por Página
|
per_page | integer |
O número por página. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
id | string |
O identificador. |
|
Tipo
|
type | string |
O tipo. |
|
Nome
|
name | string |
O nome. |
|
Nome ID de tradução
|
nameTranslationId | string |
O identificador de tradução de nomes. |
|
Message
|
message | string |
A mensagem. |
|
ID de tradução de mensagem
|
messageTranslationId | string |
O identificador de tradução de mensagens. |
|
Mensagem HTML
|
messageHtml | string |
A mensagem HTML. |
|
ID de Tradução HTML da Mensagem
|
messageHtmlTranslationId | string |
O identificador de tradução HTML da mensagem. |
|
Situação
|
status | string |
O status. |
|
Notificar
|
notify | boolean |
Notificação ou não . |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
ID do Site
|
siteId | string |
O identificador do site. |
|
Importado da página de status
|
importedFromStatuspage | boolean |
Se importado da página de status. |
|
Suprimido em
|
deletedAt | string |
Quando excluído em. |
|
Components
|
components | array of object | |
|
ID
|
components.id | string |
O identificador. |
|
Situação
|
components.status | string |
O status. |
|
ID do componente
|
components.componentId | string |
O identificador do componente. |
|
ID do modelo
|
components.templateId | string |
O identificador do modelo. |
|
Importado da página de status
|
components.importedFromStatuspage | boolean |
Se importado da página de status. |
|
Nome
|
translations.name | string |
O nome. |
|
Message
|
translations.message | string |
A mensagem. |
Obter páginas de estado
Recupere uma lista de suas páginas de status.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
A página. |
|
|
Número por Página
|
per_page | integer |
O número por página. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
id | string |
O identificador. |
|
Subdomain
|
subdomain | string |
O subdomínio. |
|
Nome
|
name | string |
O nome. |
|
URL do logótipo
|
logoUrl | string |
O endereço URL do logotipo. |
|
Favicon URL
|
faviconUrl | string |
O endereço URL favicon. |
|
URL do site
|
websiteUrl | string |
O endereço URL do site. |
|
Custom Domain
|
customDomain | string |
O domínio personalizado. |
|
E-mail público
|
publicEmail | string |
O e-mail público. |
|
Twitter
|
string |
O identificador do Twitter. |
|
|
Situação
|
status | string |
O status. |
|
Subscrever por SMS
|
subscribeBySms | boolean |
Se a subscrição por SMS está ativada. |
|
Linguagem
|
language | string |
A língua. |
|
Usar cabeçalho grande
|
useLargeHeader | boolean |
Se deve usar um cabeçalho grande. |
|
Cor da Marca
|
brandColor | string |
A cor da marca. |
|
OK Cor
|
okColor | string |
A cor OK. |
|
Cor interrompida
|
disruptedColor | string |
A cor interrompida. |
|
Cor degradada
|
degradedColor | string |
A cor degradada. |
|
Cor para baixo
|
downColor | string |
A cor para baixo. |
|
Cor do aviso
|
noticeColor | string |
A cor do aviso. |
|
Cor desconhecida
|
unknownColor | string |
A cor desconhecida. |
|
Google Analytics
|
googleAnalytics | string |
O Google Analytics. |
|
Serviço de SMS
|
smsService | string |
O serviço de SMS. |
|
HTML em Meta
|
htmlInMeta | string |
O HTML no meta. |
|
HTML acima do cabeçalho
|
htmlAboveHeader | string |
O cabeçalho HTML acima. |
|
HTML abaixo do cabeçalho
|
htmlBelowHeader | string |
O cabeçalho HTML abaixo. |
|
HTML acima do rodapé
|
htmlAboveFooter | string |
O rodapé HTML acima. |
|
HTML abaixo do rodapé
|
htmlBelowFooter | string |
O HTML abaixo do rodapé. |
|
HTML abaixo Resumo
|
htmlBelowSummary | string |
O HTML abaixo resume. |
|
Data de Lançamento
|
launchDate | string |
A data de lançamento. |
|
CSS Global
|
cssGlobal | string |
O CSS global. |
|
A bordo
|
onboarded | string |
O embarcado. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
Obter subscritores
Recupere uma lista de assinantes de uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
Página
|
page | integer |
A página. |
|
|
Número por Página
|
per_page | integer |
O número por página. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
|
array of object | ||
|
ID
|
id | string |
O identificador. |
|
Email
|
string |
O endereço de e-mail. |
|
|
Telemóvel
|
phone | string |
O número de telefone. |
|
webhook
|
webhook | string |
O webhook. |
|
Endereço eletrónico Webhook
|
webhookEmail | string |
O endereço de e-mail webhook. |
|
Confirmado
|
confirmed | boolean |
Se confirmado. |
|
Todos
|
all | boolean |
Se todos. |
|
Components
|
components | array of string |
Os componentes. |
Página de status da atualização
Atualize uma página de status criada.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID
|
id | string |
O identificador. |
|
|
Nome
|
name | string |
O nome. |
|
|
Situação
|
status | string |
O status. |
|
|
Subdomain
|
subdomain | string |
O subdomínio. |
|
|
URL do logótipo
|
logoUrl | string |
O endereço URL do logotipo. |
|
|
Favicon URL
|
faviconUrl | string |
O endereço URL favicon. |
|
|
URL do site
|
websiteUrl | string |
O endereço URL do site. |
|
|
Linguagem
|
language | string |
A língua. |
|
|
E-mail público
|
publicEmail | string |
O endereço de e-mail público. |
|
|
Usar cabeçalho grande
|
useLargeHeader | boolean |
Se deve usar um cabeçalho grande. |
|
|
Cor da Marca
|
brandColor | string |
A cor da marca. |
|
|
OK Cor
|
okColor | string |
A cor OK. |
|
|
Cor interrompida
|
disruptedColor | string |
A cor interrompida. |
|
|
Cor degradada
|
degradedColor | string |
A cor degradada. |
|
|
Cor para baixo
|
downColor | string |
A cor para baixo. |
|
|
Cor do aviso
|
noticeColor | string |
A cor do aviso. |
|
|
Cor desconhecida
|
unknownColor | string |
A cor desconhecida. |
|
|
Google Analytics
|
googleAnalytics | string |
O Google Analytics. |
|
|
Subscrever por SMS
|
subscribeBySms | boolean |
Se pretende subscrever por SMS. |
|
|
Serviço de SMS
|
smsService | string |
O serviço de SMS. |
|
|
Twilio SID
|
twilioSid | string |
O SID Twilio. |
|
|
Twilio Token
|
twilioToken | string |
O token Twilio. |
|
|
Twilio Remetente
|
twilioSender | string |
O remetente Twilio. |
|
|
HTML em Meta
|
htmlInMeta | string |
O HTML no meta. |
|
|
HTML acima do cabeçalho
|
htmlAboveHeader | string |
O cabeçalho HTML acima. |
|
|
HTML abaixo do cabeçalho
|
htmlBelowHeader | string |
O cabeçalho HTML abaixo. |
|
|
HTML acima do rodapé
|
htmlAboveFooter | string |
O rodapé HTML acima. |
|
|
HTML abaixo do rodapé
|
htmlBelowFooter | string |
O HTML abaixo do rodapé. |
|
|
HTML abaixo Resumo
|
htmlBelowSummary | string |
O HTML abaixo resume. |
|
|
CSS Global
|
cssGlobal | string |
O CSS global. |
|
|
Data de Lançamento
|
launchDate | string |
A data de lançamento. |
|
|
Formato de data
|
dateFormat | string |
O formato de data. |
|
|
Formato de Data Curto
|
dateFormatShort | string |
O formato de data curto. |
|
|
Formato de hora
|
timeFormat | string |
O formato de hora. |
|
|
Privado
|
private | boolean |
Se privado. |
|
|
Usar a Lista de Permissões
|
useAllowList | boolean |
Se a lista de permissões deve ser usada. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
Subdomain
|
subdomain | string |
O subdomínio. |
|
Nome
|
name | string |
O nome. |
|
Situação
|
status | string |
O status. |
|
URL do logótipo
|
logoUrl | string |
O endereço URL do logotipo. |
|
Favicon URL
|
faviconUrl | string |
O endereço URL favicon. |
|
URL do site
|
websiteUrl | string |
O endereço URL do site. |
|
Cor
|
color | string |
A cor. |
|
Linguagem
|
language | string |
A língua. |
|
Google Analytics
|
googleAnalytics | string |
O Google Analytics. |
|
E-mail público
|
publicEmail | string |
O endereço de e-mail público. |
|
Custom Domain
|
customDomain | string |
O domínio personalizado. |
|
Usar cabeçalho grande
|
useLargeHeader | boolean |
Se deve usar um cabeçalho grande. |
|
Desativar o Modo Escuro
|
disableDarkMode | string |
O modo escuro desativado. |
|
Twitter
|
string |
O identificador do Twitter. |
|
|
Subscrever por SMS
|
subscribeBySms | string |
A subscrição por SMS. |
|
Cor da Marca
|
brandColor | string |
A cor da marca. |
|
OK Cor
|
okColor | string |
A cor OK. |
|
Cor interrompida
|
disruptedColor | string |
A cor interrompida. |
|
Cor para baixo
|
downColor | string |
A cor para baixo. |
|
Cor degradada
|
degradedColor | string |
A cor degradada. |
|
Cor do aviso
|
noticeColor | string |
A cor do aviso. |
|
HTML em Meta
|
htmlInMeta | string |
O HTML no meta. |
|
HTML acima do cabeçalho
|
htmlAboveHeader | string |
O cabeçalho HTML acima. |
|
HTML abaixo do cabeçalho
|
htmlBelowHeader | string |
O cabeçalho HTML abaixo. |
|
HTML acima do rodapé
|
htmlAboveFooter | string |
O rodapé HTML acima. |
|
HTML abaixo do rodapé
|
htmlBelowFooter | string |
O HTML abaixo do rodapé. |
|
HTML abaixo Resumo
|
htmlBelowSummary | string |
O HTML abaixo resume. |
|
CSS Global
|
cssGlobal | string |
O CSS global. |
|
A bordo
|
onboarded | string |
O embarcado. |
|
Data de Lançamento
|
launchDate | string |
A data de lançamento. |
|
Formato de data
|
dateFormat | string |
O formato de data. |
|
Formato de Data Curto
|
dateFormatShort | string |
O formato de data curto. |
|
Formato de hora
|
timeFormat | string |
O formato de hora. |
|
Privado
|
private | boolean |
Se privado. |
|
Usar a Lista de Permissões
|
useAllowList | boolean |
Se a lista de permissões deve ser usada. |
|
Lista de Permissões
|
allowList | array of |
A lista de permissões. |
|
Components
|
components | array of object | |
|
ID
|
components.id | string |
O identificador. |
|
Nome
|
components.name | string |
O nome. |
|
Situação
|
components.status | string |
O status. |
|
Mostrar tempo de atividade
|
components.showUptime | boolean |
Se deseja mostrar o tempo de atividade. |
|
Encomenda
|
components.order | string |
A ordem. |
|
Grupo
|
components.group | string |
O grupo. |
|
Incidentes
|
components.incidents | array of string |
Os incidentes. |
Remover subscritor
Remova um assinante de uma página.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do Assinante
|
subscriber_id | True | string |
O ID do assinante. |
Devoluções
- response
- string
Resolver incidente com modelo
Resolve um incidente em uma página com um modelo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da página
|
page_id | True | string |
O identificador de página. |
|
ID do incidente
|
incident_id | True | string |
O identificador de incidente. |
|
Template
|
template | True | string |
O modelo. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | string |
O identificador. |
|
Message
|
message | string |
A mensagem. |
|
ID de tradução de mensagem
|
messageTranslationId | string |
O identificador de tradução de mensagens. |
|
Situação
|
status | string |
O status. |
|
Notificar
|
notify | boolean |
Se deve notificar. |
|
Started
|
started | string |
Quando iniciado. |
|
Ended
|
ended | string |
Quando terminou. |
|
Duração
|
duration | string |
A duração. |
|
Criado em
|
createdAt | string |
Quando criado em. |
|
Atualizado em
|
updatedAt | string |
Quando atualizado em. |
|
ID do incidente
|
incidentId | string |
O identificador de incidente. |
|
Mensagem HTML
|
messageHtml | string |
A mensagem HTML. |
|
ID de tradução HTML da mensagem
|
messageHtmlTranslationId | string |
O identificador de tradução HTML da mensagem. |
|
Importado da página de status
|
importedFromStatuspage | boolean |
Se . |
Definições
cadeia (de caracteres)
Este é o tipo de dados básico 'string'.