[comment]: # ({3a2a8d58-3a2a8d58})
# script.execute

[comment]: # ({/3a2a8d58-3a2a8d58})

[comment]: # ({ac5defee-60a9dbe3})
### Descrição

`object script.execute(object parameters)`

Este método permite executar um script em um host ou evento. Exceto para scripts do tipo URL. Estes não são executáveis.

::: noteclassic
Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja [Funções de usuário](/manual/web_interface/frontend_sections/users/user_roles) para mais informações.
:::

[comment]: # ({/ac5defee-60a9dbe3})

[comment]: # ({4a3ef91f-e4fa8ac7})
### Parâmetros

`(object)` Parâmetros contendo o ID do script a ser executado, o ID do host ou o ID do evento e o valor de manualinput.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|scriptid|ID|ID do [script](/manual/api/reference/script/object#script) a ser executado.<br><br>[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):<br>- *obrigatório*|
|hostid|ID|ID do [host](/manual/api/reference/host/object#host) no qual executar o script.<br><br>[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):<br>- *obrigatório* se `eventid` não estiver definido|
|eventid|ID|ID do [evento](/manual/api/reference/event/object#event) no qual executar o script.<br><br>[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):<br>- *obrigatório* se `hostid` não estiver definido|
|manualinput|string|Valor fornecido pelo usuário para executar o script, substituindo <br>a macro {MANUALINPUT}.|

[comment]: # ({/4a3ef91f-e4fa8ac7})

[comment]: # ({abb1babb-dde54e60})
### Valores de retorno

`(object)` Retorna o resultado da execução do script.

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|response|string|Se o script foi executado com sucesso.<br><br>Valor possível - `success`.|
|value|string|Saída do script.|
|debug|object|Contém um objeto [debug](/manual/api/reference/script/object#debug) se um script de webhook for executado. Para outros tipos de script, contém um objeto vazio.|

[comment]: # ({/abb1babb-dde54e60})

[comment]: # ({b41637d2-b41637d2})
### Exemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({89444531-03cb1cf3})
#### Execute um script de webhook

Execute um script de webhook que envia uma solicitação HTTP para um serviço externo.

[Request](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "script.execute",
    "params": {
        "scriptid": "4",
        "hostid": "30079"
    },
    "id": 1
}
```

Resposta:

```json
{
    "jsonrpc": "2.0",
    "result": {
        "response": "success",
        "value": "{\"status\":\"sent\",\"timestamp\":\"1611235391\"}",
        "debug": {
            "logs": [
                 {
                     "level": 3,
                     "ms": 480,
                     "message": "[Webhook Script] HTTP status: 200."
                 }
             ],
             "ms": 495
        }
    },
    "id": 1
}
```

[comment]: # ({/89444531-03cb1cf3})

[comment]: # ({fc7b2309-baebff97})
#### Execute um script personalizado

Execute um script "ping" em um host.

[Requisição](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "script.execute",
    "params": {
        "scriptid": "1",
        "hostid": "30079"
    },
    "id": 1
}
```

Resposta:

```json
{
    "jsonrpc": "2.0",
    "result": {
        "response": "success",
        "value": "PING 127.0.0.1 (127.0.0.1) 56(84) bytes of data.\n64 bytes from 127.0.0.1: icmp_req=1 ttl=64 time=0.074 ms\n64 bytes from 127.0.0.1: icmp_req=2 ttl=64 time=0.030 ms\n64 bytes from 127.0.0.1: icmp_req=3 ttl=64 time=0.030 ms\n\n--- 127.0.0.1 ping statistics ---\n3 packets transmitted, 3 received, 0% packet loss, time 1998ms\nrtt min/avg/max/mdev = 0.030/0.044/0.074/0.022 ms\n",
        "debug": []
    },
    "id": 1
}
```

[comment]: # ({/fc7b2309-baebff97})

[comment]: # ({7ff793a4-dae60a2d})
#### Execute um script personalizado com entrada manual

Execute um script "ping" com o comando "ping -c {MANUALINPUT} {HOST.CONN}; case $? in [01]) true;; *)
false;; esac" em um host.

[Requisição](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "script.execute",
    "params": {
        "scriptid": "7",
        "hostid": "30079",
        "manualinput": "2"
    },
    "id": 1
}
```

Resposta:

```json
{
    "jsonrpc": "2.0",
    "result": {
        "response": "success",
        "value": "PING 127.0.0.1 (127.0.0.1) 56(84) bytes of data.\n64 bytes from 127.0.0.1: icmp_seq=1 ttl=64 time=0.051 ms\n64 bytes from 127.0.0.1: icmp_seq=2 ttl=64 time=0.025 ms\n\n--- 127.0.0.1 ping statistics ---\n2 packets transmitted, 2 received, 0% packet loss, time 1021ms\nrtt min/avg/max/mdev = 0.025/0.038/0.051/0.013 ms\n",
        "debug": []
    },
    "id": 1
}
```

[comment]: # ({/7ff793a4-dae60a2d})

[comment]: # ({e7dc45a5-e7dc45a5})
### Fonte

CScript::execute() in *ui/include/classes/api/services/CScript.php*.

[comment]: # ({/e7dc45a5-e7dc45a5})