You can also view Looker’s interactive API documentation on the Looker Developer Portal or by using the API Explorer extension.
Lock All beta
Implementation Notes
** ### Generate Lockfile for All LookML Dependencies.**
Git must have been configured, must be in dev mode and deploy permission required
Install_all is a two step process
1. For each remote_dependency in a project the dependency manager will resolve any ambiguous ref.
2. The project will then write out a lockfile including each remote_dependency with its resolved ref.
Response Class
string
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Id of project | string | string |
fields | false | Requested fields | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Returns 204 if dependencies successfully installed, otherwise 400 with an error message |
Get All Git Branches beta
Implementation Notes
Get All Git Branches.
Returns a list of git branches in the project repository
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Active Git Branch beta
Implementation Notes
Get the Current Git Branch.
Returns the git branch currently checked out in the given project repository
Response Class
name
results in git checkout <new_name>
,ref
results in `git reset —hard Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Checkout New Git Branch beta
Implementation Notes
Create and Checkout a Git Branch.
Creates and checks out a new branch in the given project repository
Only allowed in development mode
- Call update_session
to select the ‘dev’ workspace.
Optionally specify a branch name, tag name or commit SHA as the start point in the ref field. If no ref is specified, HEAD of the current branch will be used as the start point for the new branch.
Response Class
name
results in git checkout <new_name>
,ref
results in `git reset —hard Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
body | true | Git Branch | body |
GitBranch {
can (object, read-only): Operations the current user is able to perform on this object, name (string): The short name on the local. Updating name results in git checkout <new_name> ,remote (string, read-only): The name of the remote, remote_name (string, read-only): The short name on the remote, error (string, read-only): Name of error, message (string, read-only): Message describing an error if present, owner_name (string, read-only): Name of the owner of a personal branch, readonly (boolean, read-only): Whether or not this branch is readonly, personal (boolean, read-only): Whether or not this branch is a personal branch - readonly for all developers except the owner, is_local (boolean, read-only): Whether or not a local ref exists for the branch, is_remote (boolean, read-only): Whether or not a remote ref exists for the branch, is_production (boolean, read-only): Whether or not this is the production branch, ahead_count (long, read-only): Number of commits the local branch is ahead of the remote, behind_count (long, read-only): Number of commits the local branch is behind the remote, commit_at (long, read-only): UNIX timestamp at which this branch was last committed., ref (string): The resolved ref of this branch. Updating ref results in `git reset —hard remote_ref (string, read-only): The resolved ref of this branch remote. }
|
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update Project Git Branch beta
Implementation Notes
Checkout and/or reset —hard an existing Git Branch.
Only allowed in development mode
- Call update_session
to select the ‘dev’ workspace.
Checkout an existing branch if name field is different from the name of the currently checked out branch.
Optionally specify a branch name, tag name or commit SHA to which the branch should be reset. DANGER hard reset will be force pushed to the remote. Unsaved changes and commits may be permanently lost.
Response Class
name
results in git checkout <new_name>
,ref
results in `git reset —hard Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
body | true | Git Branch | body |
GitBranch {
can (object, read-only): Operations the current user is able to perform on this object, name (string): The short name on the local. Updating name results in git checkout <new_name> ,remote (string, read-only): The name of the remote, remote_name (string, read-only): The short name on the remote, error (string, read-only): Name of error, message (string, read-only): Message describing an error if present, owner_name (string, read-only): Name of the owner of a personal branch, readonly (boolean, read-only): Whether or not this branch is readonly, personal (boolean, read-only): Whether or not this branch is a personal branch - readonly for all developers except the owner, is_local (boolean, read-only): Whether or not a local ref exists for the branch, is_remote (boolean, read-only): Whether or not a remote ref exists for the branch, is_production (boolean, read-only): Whether or not this is the production branch, ahead_count (long, read-only): Number of commits the local branch is ahead of the remote, behind_count (long, read-only): Number of commits the local branch is behind the remote, commit_at (long, read-only): UNIX timestamp at which this branch was last committed., ref (string): The resolved ref of this branch. Updating ref results in `git reset —hard remote_ref (string, read-only): The resolved ref of this branch remote. }
|
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Find a Git Branch beta
Implementation Notes
Get the specified Git Branch.
Returns the git branch specified in branch_name path param if it exists in the given project repository
Response Class
name
results in git checkout <new_name>
,ref
results in `git reset —hard Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
branch_name | true | Branch Name | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Delete a Git Branch beta
Implementation Notes
Delete the specified Git Branch.
Delete git branch specified in branch_name path param from local and remote of specified project repository
Response Class
None
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
branch_name | true | Branch Name | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Successfully deleted. | string |
Deploy Remote Branch or Ref to Production beta
Implementation Notes
Deploy a Remote Branch or Ref to Production.
Git must have been configured and deploy permission required.
Deploy is a one/two step process 1. If this is the first deploy of this project, create the production project with git repository. 2. Pull the branch or ref into the production project.
Can only specify either a branch or a ref.
Response Class
string
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Id of project | string | string |
branch | false | Branch to deploy to production | string | string |
ref | false | Ref to deploy to production | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Returns 204 if project was successfully deployed to production, otherwise 400 with an error message |
Deploy To Production beta
Implementation Notes
Deploy LookML from this Development Mode Project to Production.
Git must have been configured, must be in dev mode and deploy permission required
Deploy is a two / three step process:
- Push commits in current branch of dev mode project to the production branch (origin/master). Note a. This step is skipped in read-only projects. Note b. If this step is unsuccessful for any reason (e.g. rejected non-fastforward because production branch has commits not in current branch), subsequent steps will be skipped.
- If this is the first deploy of this project, create the production project with git repository.
- Pull the production branch into the production project.
Response Class
string
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Id of project | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Returns 204 if project was successfully deployed to production, otherwise 400 with an error message |
Reset To Production beta
Implementation Notes
Reset a project to the revision of the project that is in production.
DANGER this will delete any changes that have not been pushed to a remote repository.
Response Class
string
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Id of project | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Returns 204 if project was successfully reset, otherwise 400 with an error message |
Reset To Remote beta
Implementation Notes
Reset a project development branch to the revision of the project that is on the remote.
DANGER this will delete any changes that have not been pushed to a remote repository.
Response Class
string
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Id of project | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Returns 204 if project was successfully reset, otherwise 400 with an error message |
Get All Projects beta
Implementation Notes
Get All Projects.
Returns all projects visible to the current user
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
fields | false | Requested fields | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Create Project beta
Implementation Notes
Create A Project.
dev mode required.
- Call update_session
to select the ‘dev’ workspace.
name
is required.
git_remote_url
is not allowed. To configure Git for the newly created project, follow the instructions in update_project
.
Response Class
validation_required
is true. (allow_warnings
does nothing if validation_required
is false).,Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
body | true | Project | body |
Project {
can (object, read-only): Operations the current user is able to perform on this object, id (string, read-only): Project Id, name (string): Project display name, uses_git (boolean, read-only): If true the project is configured with a git repository, git_remote_url (string): Git remote repository url, git_username (string): Git username for HTTPS authentication. (For production only, if using user attributes.), git_password (string): (Write-Only) Git password for HTTPS authentication. (For production only, if using user attributes.), git_production_branch_name (string): Git production branch name. Defaults to master. Supported only in Looker 21.0 and higher., use_git_cookie_auth (boolean): If true, the project uses a git cookie for authentication., git_username_user_attribute (string): User attribute name for username in per-user HTTPS authentication., git_password_user_attribute (string): User attribute name for password in per-user HTTPS authentication., git_service_name (string): Name of the git service provider, git_application_server_http_port (long): Port that HTTP(S) application server is running on (for PRs, file browsing, etc.), git_application_server_http_scheme (string): Scheme that is running on application server (for PRs, file browsing, etc.), deploy_secret (string): (Write-Only) Optional secret token with which to authenticate requests to the webhook deploy endpoint. If not set, endpoint is unauthenticated., unset_deploy_secret (boolean): (Write-Only) When true, unsets the deploy secret to allow unauthenticated access to the webhook deploy endpoint., pull_request_mode (string): The git pull request policy for this project. Valid values are: "off", "links", "recommended", "required"., validation_required (boolean): Validation policy: If true, the project must pass validation checks before project changes can be committed to the git repository, git_release_mgmt_enabled (boolean): If true, advanced git release management is enabled for this project, allow_warnings (boolean): Validation policy: If true, the project can be committed with warnings when validation_required is true. (allow_warnings does nothing if validation_required is false).,is_example (boolean, read-only): If true the project is an example project and cannot be modified, dependency_status (string): Status of dependencies in your manifest & lockfile }
|
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Project beta
Implementation Notes
Get A Project.
Returns the project with the given project id
Response Class
validation_required
is true. (allow_warnings
does nothing if validation_required
is false).,Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
fields | false | Requested fields | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update Project beta
Implementation Notes
Update Project Configuration.
Apply changes to a project’s configuration.
Configuring Git for a Project
To set up a Looker project with a remote git repository, follow these steps:
- Call
update_session
to select the ‘dev’ workspace. - Call
create_git_deploy_key
to create a new deploy key for the project - Copy the deploy key text into the remote git repository’s ssh key configuration
- Call
update_project
to set project’sgit_remote_url
()andgit_service_name
, if necessary).
When you modify a project’s git_remote_url
, Looker connects to the remote repository to fetch
metadata. The remote git repository MUST be configured with the Looker-generated deploy
key for this project prior to setting the project’s git_remote_url
.
To set up a Looker project with a git repository residing on the Looker server (a ‘bare’ git repo):
- Call
update_session
to select the ‘dev’ workspace. - Call
update_project
settinggit_remote_url
to null andgit_service_name
to “bare”.
Response Class
validation_required
is true. (allow_warnings
does nothing if validation_required
is false).,Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
body | true | Project | body |
Project {
can (object, read-only): Operations the current user is able to perform on this object, id (string, read-only): Project Id, name (string): Project display name, uses_git (boolean, read-only): If true the project is configured with a git repository, git_remote_url (string): Git remote repository url, git_username (string): Git username for HTTPS authentication. (For production only, if using user attributes.), git_password (string): (Write-Only) Git password for HTTPS authentication. (For production only, if using user attributes.), git_production_branch_name (string): Git production branch name. Defaults to master. Supported only in Looker 21.0 and higher., use_git_cookie_auth (boolean): If true, the project uses a git cookie for authentication., git_username_user_attribute (string): User attribute name for username in per-user HTTPS authentication., git_password_user_attribute (string): User attribute name for password in per-user HTTPS authentication., git_service_name (string): Name of the git service provider, git_application_server_http_port (long): Port that HTTP(S) application server is running on (for PRs, file browsing, etc.), git_application_server_http_scheme (string): Scheme that is running on application server (for PRs, file browsing, etc.), deploy_secret (string): (Write-Only) Optional secret token with which to authenticate requests to the webhook deploy endpoint. If not set, endpoint is unauthenticated., unset_deploy_secret (boolean): (Write-Only) When true, unsets the deploy secret to allow unauthenticated access to the webhook deploy endpoint., pull_request_mode (string): The git pull request policy for this project. Valid values are: "off", "links", "recommended", "required"., validation_required (boolean): Validation policy: If true, the project must pass validation checks before project changes can be committed to the git repository, git_release_mgmt_enabled (boolean): If true, advanced git release management is enabled for this project, allow_warnings (boolean): Validation policy: If true, the project can be committed with warnings when validation_required is true. (allow_warnings does nothing if validation_required is false).,is_example (boolean, read-only): If true the project is an example project and cannot be modified, dependency_status (string): Status of dependencies in your manifest & lockfile }
|
fields | false | Requested fields | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
500 | Server Error |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Manifest beta
Implementation Notes
Get A Projects Manifest object.
Returns the project with the given project id
Response Class
ImportedProject {
LocalizationSettings {
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Create Deploy Key beta
Implementation Notes
Create Git Deploy Key.
Create a public/private key pair for authenticating ssh git requests from Looker to a remote git repository for a particular Looker project.
Returns the public key of the generated ssh key pair.
Copy this public key to your remote git repository’s ssh keys configuration so that the remote git service can validate and accept git requests from the Looker server.
Response Class
string
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Git Deploy Key beta
Implementation Notes
Git Deploy Key.
Returns the ssh public key previously created for a project’s git repository.
Response Class
string
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Validate Project beta
Implementation Notes
Validate Project.
Performs lint validation of all lookml files in the project. Returns a list of errors found, if any.
Validating the content of all the files in a project can be computationally intensive
for large projects. For best performance, call validate_project(project_id)
only
when you really want to recompute project validation. To quickly display the results of
the most recent project validation (without recomputing), use project_validation_results(project_id)
Response Class
ProjectError {
ModelsNotValidated {
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
fields | false | Requested fields | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Cached Project Validation Results beta
Implementation Notes
Get Cached Project Validation Results.
Returns the cached results of a previous project validation calculation, if any. Returns http status 204 No Content if no validation results exist.
Validating the content of all the files in a project can be computationally intensive for large projects. Use this API to simply fetch the results of the most recent project validation rather than revalidating the entire project from scratch.
A value of "stale": true
in the response indicates that the project has changed since
the cached validation results were computed. The cached validation results may no longer
reflect the current state of the project.
Response Class
ProjectError {
ModelsNotValidated {
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
fields | false | Requested fields | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Deleted |
Get Project Workspace beta
Implementation Notes
Get Project Workspace.
Returns information about the state of the project files in the currently selected workspace
Response Class
GitBranch {
name
results in git checkout <new_name>
,ref
results in `git reset —hard Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
fields | false | Requested fields | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get All Project Files beta
Implementation Notes
Get All Project Files.
Returns a list of the files in the project
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
fields | false | Requested fields | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Project File beta
Implementation Notes
Get Project File Info.
Returns information about a file in the project
Response Class
GitStatus {
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
file_id | true | File Id | string | string |
fields | false | Requested fields | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get All Git Connection Tests beta
Implementation Notes
Get All Git Connection Tests.
dev mode required.
- Call update_session
to select the ‘dev’ workspace.
Returns a list of tests which can be run against a project’s (or the dependency project for the provided remote_url) git connection. Call Run Git Connection Test) to execute each test in sequence.
Tests are ordered by increasing specificity. Tests should be run in the order returned because later tests require functionality tested by tests earlier in the test list.
For example, a late-stage test for write access is meaningless if connecting to the git server (an early test) is failing.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
remote_url | false | (Optional: leave blank for root project) The remote url for remote dependency to test. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Run Git Connection Test beta
Implementation Notes
Run a git connection test.
Run the named test on the git service used by this project (or the dependency project for the provided remote_url) and return the result. This is intended to help debug git connections when things do not work properly, to give more helpful information about why a git url is not working with Looker.
Tests should be run in the order they are returned by Get All Git Connection Tests).
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
test_id | true | Test Id | string | string |
remote_url | false | (Optional: leave blank for root project) The remote url for remote dependency to test. | string | string |
use_production | false | (Optional: leave blank for dev credentials) Whether to use git production credentials. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get All LookML Tests beta
Implementation Notes
Get All LookML Tests.
Returns a list of tests which can be run to validate a project’s LookML code and/or the underlying data, optionally filtered by the file id. Call Run LookML Test) to execute tests.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
file_id | false | File Id | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Run LookML Test beta
Implementation Notes
Run LookML Tests.
Runs all tests in the project, optionally filtered by file, test, and/or model.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
file_id | false | File Name | string | string |
test | false | Test Name | string | string |
model | false | Model Name | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Tag Ref
Implementation Notes
Creates a tag for the most recent commit, or a specific ref is a SHA is provided.
This is an internal-only, undocumented route.
Response Class
validation_required
is true. (allow_warnings
does nothing if validation_required
is false).,Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
project_id | true | Project Id | string | string |
body | true | Project | body |
Project {
can (object, read-only): Operations the current user is able to perform on this object, id (string, read-only): Project Id, name (string): Project display name, uses_git (boolean, read-only): If true the project is configured with a git repository, git_remote_url (string): Git remote repository url, git_username (string): Git username for HTTPS authentication. (For production only, if using user attributes.), git_password (string): (Write-Only) Git password for HTTPS authentication. (For production only, if using user attributes.), git_production_branch_name (string): Git production branch name. Defaults to master. Supported only in Looker 21.0 and higher., use_git_cookie_auth (boolean): If true, the project uses a git cookie for authentication., git_username_user_attribute (string): User attribute name for username in per-user HTTPS authentication., git_password_user_attribute (string): User attribute name for password in per-user HTTPS authentication., git_service_name (string): Name of the git service provider, git_application_server_http_port (long): Port that HTTP(S) application server is running on (for PRs, file browsing, etc.), git_application_server_http_scheme (string): Scheme that is running on application server (for PRs, file browsing, etc.), deploy_secret (string): (Write-Only) Optional secret token with which to authenticate requests to the webhook deploy endpoint. If not set, endpoint is unauthenticated., unset_deploy_secret (boolean): (Write-Only) When true, unsets the deploy secret to allow unauthenticated access to the webhook deploy endpoint., pull_request_mode (string): The git pull request policy for this project. Valid values are: "off", "links", "recommended", "required"., validation_required (boolean): Validation policy: If true, the project must pass validation checks before project changes can be committed to the git repository, git_release_mgmt_enabled (boolean): If true, advanced git release management is enabled for this project, allow_warnings (boolean): Validation policy: If true, the project can be committed with warnings when validation_required is true. (allow_warnings does nothing if validation_required is false).,is_example (boolean, read-only): If true the project is an example project and cannot be modified, dependency_status (string): Status of dependencies in your manifest & lockfile }
|
commit_sha | false | (Optional): Commit Sha to Tag | string | string |
tag_name | false | Tag Name | string | string |
tag_message | false | (Optional): Tag Message | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Returns 204 if tagging a ref was successful, otherwise 400 with an error message |
Create Repository Credential beta
Implementation Notes
Configure Repository Credential for a remote dependency.
Admin required.
root_project_id
is required.
credential_id
is required.
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
root_project_id | true | Root Project Id | string | string |
credential_id | true | Credential Id | string | string |
body | true | Remote Project Information | body |
RepositoryCredential {
can (object, read-only): Operations the current user is able to perform on this object, id (string, read-only): Unique Id, root_project_id (string, read-only): Root project Id, remote_url (string, read-only): Git remote repository url, git_username (string): Git username for HTTPS authentication., git_password (string): (Write-Only) Git password for HTTPS authentication., ssh_public_key (string): Public deploy key for SSH authentication., is_configured (boolean, read-only): Whether the credentials have been configured for the Git Repository. }
|
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Delete Repository Credential beta
Implementation Notes
Repository Credential for a remote dependency.
Admin required.
root_project_id
is required.
credential_id
is required.
Response Class
None
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
root_project_id | true | Root Project Id | string | string |
credential_id | true | Credential Id | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Successfully deleted. | string |
Get All Repository Credentials beta
Implementation Notes
Get all Repository Credentials for a project.
root_project_id
is required.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
root_project_id | true | Root Project Id | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|