Update Integration

Version 4.0.24.16

Update parameters on a Integration.

Request

PATCH /integrations/{integration_id}
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
integration_id
string
Id of integration
body
HTTP Body
Expand HTTP Body definition...
body
Integration
Expand Integration definition...
can
object
Operations the current user is able to perform on this object
id
string
ID of the integration.
integration_hub_id
string
ID of the integration hub.
label
string
Label for the integration.
description
string
Description of the integration.
enabled
boolean
Whether the integration is available to users.
params
supported_formats
string[]
supported_action_types
string[]
supported_formattings
string[]
supported_visualization_formattings
string[]
supported_download_settings
string[]
icon_url
string
URL to an icon for the integration.
uses_oauth
boolean
Whether the integration uses oauth.
required_fields
privacy_link
string
Link to privacy policy for destination
delegate_oauth
boolean
Whether the integration uses delegate oauth, which allows federation between an integration installation scope specific entity (like org, group, and team, etc.) and Looker.
installed_delegate_oauth_targets
string[]
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields.

Response

200: Integration

Datatype
Description
(object)
can
object
Operations the current user is able to perform on this object
id
string
ID of the integration.
integration_hub_id
string
ID of the integration hub.
label
string
Label for the integration.
description
string
Description of the integration.
enabled
boolean
Whether the integration is available to users.
params
Expand IntegrationParam definition...
name
string
Name of the parameter.
label
string
Label of the parameter.
description
string
Short description of the parameter.
required
boolean
Whether the parameter is required to be set to use the destination. If unspecified, this defaults to false.
has_value
boolean
Whether the parameter has a value set.
value
string
The current value of the parameter. Always null if the value is sensitive. When writing, null values will be ignored. Set the value to an empty string to clear it.
user_attribute_name
string
When present, the param's value comes from this user attribute instead of the 'value' parameter. Set to null to use the 'value'.
sensitive
boolean
Whether the parameter contains sensitive data like API credentials. If unspecified, this defaults to true.
per_user
boolean
When true, this parameter must be assigned to a user attribute in the admin panel (instead of a constant value), and that value may be updated by the user as part of the integration flow.
delegate_oauth_url
string
When present, the param represents the oauth url the user will be taken to.
supported_formats
string[]
supported_action_types
string[]
supported_formattings
string[]
supported_visualization_formattings
string[]
supported_download_settings
string[]
icon_url
string
URL to an icon for the integration.
uses_oauth
boolean
Whether the integration uses oauth.
required_fields
Expand IntegrationRequiredField definition...
tag
string
Matches a field that has this tag.
any_tag
string[]
all_tags
string[]
privacy_link
string
Link to privacy policy for destination
delegate_oauth
boolean
Whether the integration uses delegate oauth, which allows federation between an integration installation scope specific entity (like org, group, and team, etc.) and Looker.
installed_delegate_oauth_targets
string[]

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link