Update Project

Version 4.0.24.12

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:

  1. Call update_session to select the 'dev' workspace.
  2. Call create_git_deploy_key to create a new deploy key for the project
  3. Copy the deploy key text into the remote git repository's ssh key configuration
  4. Call update_project to set project's git_remote_url ()and git_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):

  1. Call update_session to select the 'dev' workspace.
  2. Call update_project setting git_remote_url to null and git_service_name to "bare".

Request

PATCH /projects/{project_id}
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
project_id
string
Project Id
body
HTTP Body
Expand HTTP Body definition...
body
Project
Expand Project definition...
can
object
Operations the current user is able to perform on this object
id
string
Project Id
name
string
Project display name
uses_git
boolean
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
integer
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
If true the project is an example project and cannot be modified
dependency_status
string
Status of dependencies in your manifest & lockfile
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields

Response

200: Project

Datatype
Description
(object)
can
object
Operations the current user is able to perform on this object
id
string
Project Id
name
string
Project display name
uses_git
boolean
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
integer
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
If true the project is an example project and cannot be modified
dependency_status
string
Status of dependencies in your manifest & lockfile

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

409: Resource Already Exists

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

500: Server Error

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