Version 4.0.24.16 (latest)
Update parameters on a Integration.
Request
PATCH
/integrations/{integration_id}
Datatype
Description
Request
path
Expand HTTP Path definition...
integration_id
Id of integration
body
Expand HTTP Body definition...
body
Integration
Expand Integration definition...
can
lock
Operations the current user is able to perform on this object
id
lock
ID of the integration.
integration_hub_id
lock
ID of the integration hub.
label
lock
Label for the integration.
description
lock
Description of the integration.
enabled
Whether the integration is available to users.
params
supported_formats
supported_action_types
supported_formattings
supported_visualization_formattings
supported_download_settings
icon_url
lock
URL to an icon for the integration.
uses_oauth
lock
Whether the integration uses oauth.
required_fields
privacy_link
lock
Link to privacy policy for destination
delegate_oauth
lock
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
query
Expand HTTP Query definition...
fields
Requested fields.
Response
200: Integration
Datatype
Description
(object)
can
lock
Operations the current user is able to perform on this object
id
lock
ID of the integration.
integration_hub_id
lock
ID of the integration hub.
label
lock
Label for the integration.
description
lock
Description of the integration.
enabled
Whether the integration is available to users.
params
Expand IntegrationParam definition...
name
Name of the parameter.
label
lock
Label of the parameter.
description
lock
Short description of the parameter.
required
lock
Whether the parameter is required to be set to use the destination. If unspecified, this defaults to false.
has_value
lock
Whether the parameter has a value set.
value
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
When present, the param's value comes from this user attribute instead of the 'value' parameter. Set to null to use the 'value'.
sensitive
lock
Whether the parameter contains sensitive data like API credentials. If unspecified, this defaults to true.
per_user
lock
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
lock
When present, the param represents the oauth url the user will be taken to.
supported_formats
supported_action_types
supported_formattings
supported_visualization_formattings
supported_download_settings
icon_url
lock
URL to an icon for the integration.
uses_oauth
lock
Whether the integration uses oauth.
required_fields
Expand IntegrationRequiredField definition...
tag
lock
Matches a field that has this tag.
any_tag
all_tags
privacy_link
lock
Link to privacy policy for destination
delegate_oauth
lock
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
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link