connector.create

Descrição

object connector.create(object/array connectors)

Este método permite criar novos objetos conectores.

Este método está disponível apenas para o tipo de usuário Super admin. As permissões para executar o método podem ser revogadas nas configurações de função do usuário. Para mais informações, consulte funções do usuário User roles.

Parâmetros

(object/array) Objetos conector para criar.

Além das propriedades padrão do conector standard connector properties, o método aceita os seguintes parâmetros.

Parâmetro Tipo Descrição
tags array Conector tag filter.

Valores de retorno

(object) Retorna um objeto contendo os IDs dos conectores criados sob a propriedade connectorids . A ordem dos IDs retornados corresponde à ordem dos conectores passados.

Exemplos

Criando um conector

Crie um conector para exportar eventos trigger com um filtro de tag. A autenticação HTTP será realizada usando um token Bearer.

Solicitação:

{
    "jsonrpc": "2.0",
    "method": "connector.create",
    "params": [
        {
            "name": "Export of events",
            "data_type": 1,
            "url": "{$DATA_EXPORT_URL}",
            "authtype": 5,
            "token": "{$DATA_EXPORT_BEARER_TOKEN}",
            "tags": [
                {
                    "tag": "service",
                    "operator": 0,
                    "value": "mysqld"
                }
            ]
        }
    ],
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": {
        "connectorid": [
            "3"
        ]
    },
    "id": 1
}

Fonte

CConnector::create() in ui/include/classes/api/services/CConnector.php.