Request
yaml
type: "io.kestra.plugin.graphql.request"
Examples
yaml
id: graphql_request
namespace: company.team
tasks:
- id: graphql_query
type: io.kestra.plugin.graphql.Request
uri: https://example.com/graphql
query: |
query GetUser($userId: ID!) {
user(id: $userId) {
name
email
}
}
variables:
userId: "12345"
yaml
id: graphql_with_auth
namespace: company.team
tasks:
- id: get_data
type: io.kestra.plugin.graphql.Request
uri: https://example.com/graphql
headers:
Authorization: "Bearer {{ secret('API_TOKEN') }}"
query: |
query {
viewer {
name
email
}
}
yaml
id: graphql_with_operation_name
namespace: company.team
tasks:
- id: get_data
type: io.kestra.plugin.graphql.Request
uri: https://example.com/graphql
query: |
query GetUser {
user(id: "1") {
name
}
}
query GetPosts {
posts {
title
}
}
operationName: "GetUser"
Properties
query *Requiredstring
uri *Requiredstring
body string
contentType string
Default
application/json
encryptBody booleanstring
Default
false
failOnGraphQLErrors booleanstring
Default
false
formData object
headers object
SubType string
method string
Default
POST
operationName string
options Non-dynamicHttpConfiguration
Default
{
"followRedirects": "true",
"allowFailed": "false",
"defaultCharset": "UTF-8"
}
variables object
Outputs
body object
code integer
encryptedBody string
error object
headers object
SubType array
uri string
Format
uri
Definitions
io.kestra.core.http.client.configurations.TimeoutConfiguration
connectTimeout string
Format
duration
readIdleTimeout string
Default
PT5M
Format
duration
io.kestra.core.http.client.configurations.BasicAuthConfiguration
type *Requiredobject
password string
username string
java.nio.charset.Charset
io.kestra.core.http.client.configurations.HttpConfiguration
allowFailed booleanstring
Default
false
allowedResponseCodes array
SubType integer
defaultCharset Charsetstring
Default
UTF-8
followRedirects booleanstring
Default
true
logs array
SubType string
Possible Values
REQUEST_HEADERS
REQUEST_BODY
RESPONSE_HEADERS
RESPONSE_BODY
proxy ProxyConfiguration
ssl SslOptions
timeout TimeoutConfiguration
io.kestra.core.http.client.configurations.ProxyConfiguration
address string
password string
port integerstring
type string
Default
DIRECT
Possible Values
DIRECT
HTTP
SOCKS