Reference

Management API

Use the Assistance Management API to automate platform and service operations.

Gets project performance advisors.
deprecated

get/v1/projects/{ref}/advisors/performance

This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • advisors_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

Gets project security advisors.
deprecated

get/v1/projects/{ref}/advisors/security

This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • advisors_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • lint_type
    Optional
    enum

Response codes

  • 200
  • 401
  • 403
  • 429

Gets a project's function combined statistics

get/v1/projects/{ref}/analytics/endpoints/functions.combined-stats

The fine-grained token must include the following permissions to access this endpoint:

  • analytics_usage_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • interval
    Required
    enum
  • function_id
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Gets project's logs

get/v1/projects/{ref}/analytics/endpoints/logs.all

Executes a SQL query on the project's logs.

Either the iso_timestamp_start and iso_timestamp_end parameters must be provided. If both are not provided, only the last 1 minute of logs will be queried. The timestamp range must be no more than 24 hours and is rounded to the nearest minute. If the range is more than 24 hours, a validation error will be thrown.

Note: Unless the sql parameter is provided, only edge_logs will be queried. See the log query docs for all available sources.

OAuth scopes

  • analytics:read

The fine-grained token must include the following permissions to access this endpoint:

  • analytics_logs_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • sql
    Optional
    string

    Custom SQL query to execute on the logs. See querying logs for more details.

  • iso_timestamp_start
    Optional
    string
  • iso_timestamp_end
    Optional
    string

Response codes

  • 200
  • 401
  • 403
  • 429

Gets project's usage api counts

get/v1/projects/{ref}/analytics/endpoints/usage.api-counts

The fine-grained token must include the following permissions to access this endpoint:

  • analytics_usage_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • interval
    Optional
    enum

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Gets project's usage api requests count

get/v1/projects/{ref}/analytics/endpoints/usage.api-requests-count

The fine-grained token must include the following permissions to access this endpoint:

  • analytics_usage_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Creates a new SSO provider

post/v1/projects/{ref}/config/auth/sso/providers

OAuth scopes

  • auth:write

The fine-grained token must include the following permissions to access this endpoint:

  • auth_config_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • type
    Required
    enum
  • metadata_xml
    Optional
    string
  • metadata_url
    Optional
    string
  • domains
    Optional
    Array<string>
  • attribute_mapping
    Optional
    object
  • name_id_format
    Optional
    enum

Response codes

  • 201
  • 401
  • 403
  • 404
  • 429

Set up the project's existing JWT secret as an in_use JWT signing key. This endpoint will be removed in the future always check for HTTP 404 Not Found.

post/v1/projects/{ref}/config/auth/signing-keys/legacy

OAuth scopes

  • secrets:write

The fine-grained token must include the following permissions to access this endpoint:

  • auth_signing_keys_write

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 201
  • 401
  • 403
  • 429

Create a new signing key for the project in standby status

post/v1/projects/{ref}/config/auth/signing-keys

OAuth scopes

  • secrets:write

The fine-grained token must include the following permissions to access this endpoint:

  • auth_signing_keys_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • algorithm
    Required
    enum
  • status
    Optional
    enum
  • private_jwk
    Optional
    one of the following options

Response codes

  • 201
  • 401
  • 403
  • 429

Creates a new third-party auth integration

post/v1/projects/{ref}/config/auth/third-party-auth

OAuth scopes

  • auth:write

The fine-grained token must include the following permissions to access this endpoint:

  • auth_config_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • oidc_issuer_url
    Optional
    string
  • jwks_url
    Optional
    string
  • custom_jwks
    Optional
    unknown

Response codes

  • 201
  • 401
  • 403
  • 429

Removes a SSO provider by its UUID

delete/v1/projects/{ref}/config/auth/sso/providers/{provider_id}

OAuth scopes

  • auth:write

The fine-grained token must include the following permissions to access this endpoint:

  • auth_config_write

Path parameters

  • ref
    Required
    string

    Project ref

  • provider_id
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 404
  • 429

Removes a third-party auth integration

delete/v1/projects/{ref}/config/auth/third-party-auth/{tpa_id}

OAuth scopes

  • auth:write

The fine-grained token must include the following permissions to access this endpoint:

  • auth_config_write

Path parameters

  • ref
    Required
    string

    Project ref

  • tpa_id
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 429

Gets a SSO provider by its UUID

get/v1/projects/{ref}/config/auth/sso/providers/{provider_id}

OAuth scopes

  • auth:read

The fine-grained token must include the following permissions to access this endpoint:

  • auth_config_read

Path parameters

  • ref
    Required
    string

    Project ref

  • provider_id
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 404
  • 429

Gets project's auth config

get/v1/projects/{ref}/config/auth

OAuth scopes

  • auth:read

The fine-grained token must include the following permissions to access this endpoint:

  • auth_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Get the signing key information for the JWT secret imported as signing key for this project. This endpoint will be removed in the future, check for HTTP 404 Not Found.

get/v1/projects/{ref}/config/auth/signing-keys/legacy

OAuth scopes

  • secrets:read

The fine-grained token must include the following permissions to access this endpoint:

  • auth_signing_keys_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

Get information about a signing key

get/v1/projects/{ref}/config/auth/signing-keys/{id}

The fine-grained token must include the following permissions to access this endpoint:

  • auth_signing_keys_read

Path parameters

  • id
    Required
    string
  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

List all signing keys for the project

get/v1/projects/{ref}/config/auth/signing-keys

OAuth scopes

  • secrets:read

The fine-grained token must include the following permissions to access this endpoint:

  • auth_signing_keys_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

Get a third-party integration

get/v1/projects/{ref}/config/auth/third-party-auth/{tpa_id}

OAuth scopes

  • auth:read

The fine-grained token must include the following permissions to access this endpoint:

  • auth_config_read

Path parameters

  • ref
    Required
    string

    Project ref

  • tpa_id
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 429

Lists all SSO providers

get/v1/projects/{ref}/config/auth/sso/providers

OAuth scopes

  • auth:read

The fine-grained token must include the following permissions to access this endpoint:

  • auth_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 404
  • 429

Lists all third-party auth integrations

get/v1/projects/{ref}/config/auth/third-party-auth

OAuth scopes

  • auth:read

The fine-grained token must include the following permissions to access this endpoint:

  • auth_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

Remove a signing key from a project. Only possible if the key has been in revoked status for a while.

delete/v1/projects/{ref}/config/auth/signing-keys/{id}

OAuth scopes

  • secrets:write

The fine-grained token must include the following permissions to access this endpoint:

  • auth_signing_keys_write

Path parameters

  • id
    Required
    string
  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

Updates a SSO provider by its UUID

put/v1/projects/{ref}/config/auth/sso/providers/{provider_id}

OAuth scopes

  • auth:write

The fine-grained token must include the following permissions to access this endpoint:

  • auth_config_write

Path parameters

  • ref
    Required
    string

    Project ref

  • provider_id
    Required
    string

Body

  • metadata_xml
    Optional
    string
  • metadata_url
    Optional
    string
  • domains
    Optional
    Array<string>
  • attribute_mapping
    Optional
    object
  • name_id_format
    Optional
    enum

Response codes

  • 200
  • 401
  • 403
  • 404
  • 429

Updates a project's auth config

patch/v1/projects/{ref}/config/auth

OAuth scopes

  • auth:write

The fine-grained token must include the following permissions to access this endpoint:

  • auth_config_write
  • project_admin_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • site_url
    Optional
    string
  • disable_signup
    Optional
    boolean
  • jwt_exp
    Optional
    integer
  • smtp_admin_email
    Optional
    string
  • smtp_host
    Optional
    string
  • smtp_port
    Optional
    string
  • smtp_user
    Optional
    string
  • smtp_pass
    Optional
    string
  • smtp_max_frequency
    Optional
    integer
  • smtp_sender_name
    Optional
    string
  • mailer_allow_unverified_email_sign_ins
    Optional
    boolean
  • mailer_autoconfirm
    Optional
    boolean
  • mailer_subjects_invite
    Optional
    string
  • mailer_subjects_confirmation
    Optional
    string
  • mailer_subjects_recovery
    Optional
    string
  • mailer_subjects_email_change
    Optional
    string
  • mailer_subjects_magic_link
    Optional
    string
  • mailer_subjects_reauthentication
    Optional
    string
  • mailer_subjects_password_changed_notification
    Optional
    string
  • mailer_subjects_email_changed_notification
    Optional
    string
  • mailer_subjects_phone_changed_notification
    Optional
    string
  • mailer_subjects_mfa_factor_enrolled_notification
    Optional
    string
  • mailer_subjects_mfa_factor_unenrolled_notification
    Optional
    string
  • mailer_subjects_identity_linked_notification
    Optional
    string
  • mailer_subjects_identity_unlinked_notification
    Optional
    string
  • mailer_templates_invite_content
    Optional
    string
  • mailer_templates_confirmation_content
    Optional
    string
  • mailer_templates_recovery_content
    Optional
    string
  • mailer_templates_email_change_content
    Optional
    string
  • mailer_templates_magic_link_content
    Optional
    string
  • mailer_templates_reauthentication_content
    Optional
    string
  • mailer_templates_password_changed_notification_content
    Optional
    string
  • mailer_templates_email_changed_notification_content
    Optional
    string
  • mailer_templates_phone_changed_notification_content
    Optional
    string
  • mailer_templates_mfa_factor_enrolled_notification_content
    Optional
    string
  • mailer_templates_mfa_factor_unenrolled_notification_content
    Optional
    string
  • mailer_templates_identity_linked_notification_content
    Optional
    string
  • mailer_templates_identity_unlinked_notification_content
    Optional
    string
  • mailer_notifications_password_changed_enabled
    Optional
    boolean
  • mailer_notifications_email_changed_enabled
    Optional
    boolean
  • mailer_notifications_phone_changed_enabled
    Optional
    boolean
  • mailer_notifications_mfa_factor_enrolled_enabled
    Optional
    boolean
  • mailer_notifications_mfa_factor_unenrolled_enabled
    Optional
    boolean
  • mailer_notifications_identity_linked_enabled
    Optional
    boolean
  • mailer_notifications_identity_unlinked_enabled
    Optional
    boolean
  • mfa_max_enrolled_factors
    Optional
    integer
  • uri_allow_list
    Optional
    string
  • external_anonymous_users_enabled
    Optional
    boolean
  • external_email_enabled
    Optional
    boolean
  • external_phone_enabled
    Optional
    boolean
  • saml_enabled
    Optional
    boolean
  • saml_external_url
    Optional
    string
  • security_sb_forwarded_for_enabled
    Optional
    boolean
  • security_captcha_enabled
    Optional
    boolean
  • security_captcha_provider
    Optional
    enum
  • security_captcha_secret
    Optional
    string
  • sessions_timebox
    Optional
    integer
  • sessions_inactivity_timeout
    Optional
    integer
  • sessions_single_per_user
    Optional
    boolean
  • sessions_tags
    Optional
    string
  • rate_limit_anonymous_users
    Optional
    integer
  • rate_limit_email_sent
    Optional
    integer
  • rate_limit_sms_sent
    Optional
    integer
  • rate_limit_verify
    Optional
    integer
  • rate_limit_token_refresh
    Optional
    integer
  • rate_limit_otp
    Optional
    integer
  • rate_limit_web3
    Optional
    integer
  • mailer_secure_email_change_enabled
    Optional
    boolean
  • refresh_token_rotation_enabled
    Optional
    boolean
  • password_hibp_enabled
    Optional
    boolean
  • password_min_length
    Optional
    integer
  • password_required_characters
    Optional
    enum
  • security_manual_linking_enabled
    Optional
    boolean
  • security_update_password_require_reauthentication
    Optional
    boolean
  • security_refresh_token_reuse_interval
    Optional
    integer
  • mailer_otp_exp
    Optional
    integer
  • mailer_otp_length
    Optional
    integer
  • sms_autoconfirm
    Optional
    boolean
  • sms_max_frequency
    Optional
    integer
  • sms_otp_exp
    Optional
    integer
  • sms_otp_length
    Optional
    integer
  • sms_provider
    Optional
    enum
  • sms_messagebird_access_key
    Optional
    string
  • sms_messagebird_originator
    Optional
    string
  • sms_test_otp
    Optional
    string
  • sms_test_otp_valid_until
    Optional
    string
  • sms_textlocal_api_key
    Optional
    string
  • sms_textlocal_sender
    Optional
    string
  • sms_twilio_account_sid
    Optional
    string
  • sms_twilio_auth_token
    Optional
    string
  • sms_twilio_content_sid
    Optional
    string
  • sms_twilio_message_service_sid
    Optional
    string
  • sms_twilio_verify_account_sid
    Optional
    string
  • sms_twilio_verify_auth_token
    Optional
    string
  • sms_twilio_verify_message_service_sid
    Optional
    string
  • sms_vonage_api_key
    Optional
    string
  • sms_vonage_api_secret
    Optional
    string
  • sms_vonage_from
    Optional
    string
  • sms_template
    Optional
    string
  • hook_mfa_verification_attempt_enabled
    Optional
    boolean
  • hook_mfa_verification_attempt_uri
    Optional
    string
  • hook_mfa_verification_attempt_secrets
    Optional
    string
  • hook_password_verification_attempt_enabled
    Optional
    boolean
  • hook_password_verification_attempt_uri
    Optional
    string
  • hook_password_verification_attempt_secrets
    Optional
    string
  • hook_custom_access_token_enabled
    Optional
    boolean
  • hook_custom_access_token_uri
    Optional
    string
  • hook_custom_access_token_secrets
    Optional
    string
  • hook_send_sms_enabled
    Optional
    boolean
  • hook_send_sms_uri
    Optional
    string
  • hook_send_sms_secrets
    Optional
    string
  • hook_send_email_enabled
    Optional
    boolean
  • hook_send_email_uri
    Optional
    string
  • hook_send_email_secrets
    Optional
    string
  • hook_before_user_created_enabled
    Optional
    boolean
  • hook_before_user_created_uri
    Optional
    string
  • hook_before_user_created_secrets
    Optional
    string
  • hook_after_user_created_enabled
    Optional
    boolean
  • hook_after_user_created_uri
    Optional
    string
  • hook_after_user_created_secrets
    Optional
    string
  • external_apple_enabled
    Optional
    boolean
  • external_apple_client_id
    Optional
    string
  • external_apple_email_optional
    Optional
    boolean
  • external_apple_secret
    Optional
    string
  • external_apple_additional_client_ids
    Optional
    string
  • external_azure_enabled
    Optional
    boolean
  • external_azure_client_id
    Optional
    string
  • external_azure_email_optional
    Optional
    boolean
  • external_azure_secret
    Optional
    string
  • external_azure_url
    Optional
    string
  • external_bitbucket_enabled
    Optional
    boolean
  • external_bitbucket_client_id
    Optional
    string
  • external_bitbucket_email_optional
    Optional
    boolean
  • external_bitbucket_secret
    Optional
    string
  • external_discord_enabled
    Optional
    boolean
  • external_discord_client_id
    Optional
    string
  • external_discord_email_optional
    Optional
    boolean
  • external_discord_secret
    Optional
    string
  • external_facebook_enabled
    Optional
    boolean
  • external_facebook_client_id
    Optional
    string
  • external_facebook_email_optional
    Optional
    boolean
  • external_facebook_secret
    Optional
    string
  • external_figma_enabled
    Optional
    boolean
  • external_figma_client_id
    Optional
    string
  • external_figma_email_optional
    Optional
    boolean
  • external_figma_secret
    Optional
    string
  • external_github_enabled
    Optional
    boolean
  • external_github_client_id
    Optional
    string
  • external_github_email_optional
    Optional
    boolean
  • external_github_secret
    Optional
    string
  • external_gitlab_enabled
    Optional
    boolean
  • external_gitlab_client_id
    Optional
    string
  • external_gitlab_email_optional
    Optional
    boolean
  • external_gitlab_secret
    Optional
    string
  • external_gitlab_url
    Optional
    string
  • external_google_enabled
    Optional
    boolean
  • external_google_client_id
    Optional
    string
  • external_google_email_optional
    Optional
    boolean
  • external_google_secret
    Optional
    string
  • external_google_additional_client_ids
    Optional
    string
  • external_google_skip_nonce_check
    Optional
    boolean
  • external_kakao_enabled
    Optional
    boolean
  • external_kakao_client_id
    Optional
    string
  • external_kakao_email_optional
    Optional
    boolean
  • external_kakao_secret
    Optional
    string
  • external_keycloak_enabled
    Optional
    boolean
  • external_keycloak_client_id
    Optional
    string
  • external_keycloak_email_optional
    Optional
    boolean
  • external_keycloak_secret
    Optional
    string
  • external_keycloak_url
    Optional
    string
  • external_linkedin_oidc_enabled
    Optional
    boolean
  • external_linkedin_oidc_client_id
    Optional
    string
  • external_linkedin_oidc_email_optional
    Optional
    boolean
  • external_linkedin_oidc_secret
    Optional
    string
  • external_slack_oidc_enabled
    Optional
    boolean
  • external_slack_oidc_client_id
    Optional
    string
  • external_slack_oidc_email_optional
    Optional
    boolean
  • external_slack_oidc_secret
    Optional
    string
  • external_notion_enabled
    Optional
    boolean
  • external_notion_client_id
    Optional
    string
  • external_notion_email_optional
    Optional
    boolean
  • external_notion_secret
    Optional
    string
  • external_slack_enabled
    Optional
    boolean
  • external_slack_client_id
    Optional
    string
  • external_slack_email_optional
    Optional
    boolean
  • external_slack_secret
    Optional
    string
  • external_spotify_enabled
    Optional
    boolean
  • external_spotify_client_id
    Optional
    string
  • external_spotify_email_optional
    Optional
    boolean
  • external_spotify_secret
    Optional
    string
  • external_twitch_enabled
    Optional
    boolean
  • external_twitch_client_id
    Optional
    string
  • external_twitch_email_optional
    Optional
    boolean
  • external_twitch_secret
    Optional
    string
  • external_twitter_enabled
    Optional
    boolean
  • external_twitter_client_id
    Optional
    string
  • external_twitter_email_optional
    Optional
    boolean
  • external_twitter_secret
    Optional
    string
  • external_x_enabled
    Optional
    boolean
  • external_x_client_id
    Optional
    string
  • external_x_email_optional
    Optional
    boolean
  • external_x_secret
    Optional
    string
  • external_workos_enabled
    Optional
    boolean
  • external_workos_client_id
    Optional
    string
  • external_workos_secret
    Optional
    string
  • external_workos_url
    Optional
    string
  • external_web3_solana_enabled
    Optional
    boolean
  • external_web3_ethereum_enabled
    Optional
    boolean
  • external_zoom_enabled
    Optional
    boolean
  • external_zoom_client_id
    Optional
    string
  • external_zoom_email_optional
    Optional
    boolean
  • external_zoom_secret
    Optional
    string
  • db_max_pool_size
    Optional
    integer
  • db_max_pool_size_unit
    Optional
    enum
  • api_max_request_duration
    Optional
    integer
  • mfa_totp_enroll_enabled
    Optional
    boolean
  • mfa_totp_verify_enabled
    Optional
    boolean
  • mfa_web_authn_enroll_enabled
    Optional
    boolean
  • mfa_web_authn_verify_enabled
    Optional
    boolean
  • mfa_phone_enroll_enabled
    Optional
    boolean
  • mfa_phone_verify_enabled
    Optional
    boolean
  • mfa_phone_max_frequency
    Optional
    integer
  • mfa_phone_otp_length
    Optional
    integer
  • mfa_phone_template
    Optional
    string
  • nimbus_oauth_client_id
    Optional
    string
  • nimbus_oauth_client_secret
    Optional
    string
  • oauth_server_enabled
    Optional
    boolean
  • oauth_server_allow_dynamic_registration
    Optional
    boolean
  • oauth_server_authorization_path
    Optional
    string
  • custom_oauth_enabled
    Optional
    boolean

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Update a signing key, mainly its status

patch/v1/projects/{ref}/config/auth/signing-keys/{id}

OAuth scopes

  • secrets:write

The fine-grained token must include the following permissions to access this endpoint:

  • auth_signing_keys_write

Path parameters

  • id
    Required
    string
  • ref
    Required
    string

    Project ref

Body

  • status
    Required
    enum

Response codes

  • 200
  • 401
  • 403
  • 429

Apply or update billing addons, including compute instance size

patch/v1/projects/{ref}/billing/addons

Selects an addon variant, for example scaling the project’s compute instance up or down, and applies it to the project.

The fine-grained token must include the following permissions to access this endpoint:

  • infra_add_ons_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • addon_variant
    Required
    one of the following options
  • addon_type
    Required
    enum

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

List billing addons and compute instance selections

get/v1/projects/{ref}/billing/addons

Returns the billing addons that are currently applied, including the active compute instance size, and lists every addon option that can be provisioned with pricing metadata.

The fine-grained token must include the following permissions to access this endpoint:

  • infra_add_ons_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Remove billing addons or revert compute instance sizing

delete/v1/projects/{ref}/billing/addons/{addon_variant}

Disables the selected addon variant, including rolling the compute instance back to its previous size.

The fine-grained token must include the following permissions to access this endpoint:

  • infra_add_ons_write

Path parameters

  • ref
    Required
    string

    Project ref

  • addon_variant
    Required
    one of the following options

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Apply a database migration

post/v1/projects/{ref}/database/migrations

Only available to selected partner OAuth apps

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_migrations_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • query
    Required
    string
  • name
    Optional
    string
  • rollback
    Optional
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Authorize user-id to role mappings for JIT access

post/v1/projects/{ref}/database/jit

Authorizes the request to assume a role in the project database

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_jit_read

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • role
    Required
    string
  • rhost
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Create a login role for CLI with temporary password

post/v1/projects/{ref}/cli/login-role

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • read_only
    Required
    boolean

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

Delete JIT access by user-id

delete/v1/projects/{ref}/database/jit/{user_id}

Remove JIT mappings of a user, revoking all JIT database access

The fine-grained token must include the following permissions to access this endpoint:

  • database_jit_write

Path parameters

  • ref
    Required
    string

    Project ref

  • user_id
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Delete existing login roles used by CLI

delete/v1/projects/{ref}/cli/login-role

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_write

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Disables project's readonly mode for the next 15 minutes

post/v1/projects/{ref}/readonly/temporary-disable

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_readonly_config_write

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

[Beta] Enables Database Webhooks on the project

post/v1/projects/{ref}/database/webhooks/enable

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_webhooks_config_write

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

Generate TypeScript types

get/v1/projects/{ref}/types/typescript

Returns the TypeScript types of your schema for use with assistance-js.

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • included_schemas
    Optional
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Fetch an existing entry from migration history

get/v1/projects/{ref}/database/migrations/{version}

Only available to selected partner OAuth apps

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_migrations_read

Path parameters

  • ref
    Required
    string

    Project ref

  • version
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Gets a specific SQL snippet

get/v1/snippets/{id}

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • snippets_read

Path parameters

  • id
    Required
    string

Response codes

  • 200
  • 500

Gets database metadata for the given project.
deprecated

get/v1/projects/{ref}/database/context

This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.

OAuth scopes

  • projects:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

Get user-id to role mappings for JIT access

get/v1/projects/{ref}/database/jit

Mappings of roles a user can assume in the project database

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_jit_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Get project's just-in-time access configuration.

get/v1/projects/{ref}/jit-access

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Gets project's supavisor config

get/v1/projects/{ref}/config/database/pooler

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_pooling_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Gets project's Postgres config

get/v1/projects/{ref}/config/database/postgres

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Get project's pgbouncer config

get/v1/projects/{ref}/config/database/pgbouncer

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Returns project's readonly mode status

get/v1/projects/{ref}/readonly

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_readonly_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Get project's SSL enforcement configuration.

get/v1/projects/{ref}/ssl-enforcement

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_ssl_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Lists all backups

get/v1/projects/{ref}/database/backups

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • backups_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Lists SQL snippets for the logged in user

get/v1/snippets

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • snippets_read

Query parameters

  • project_ref
    Optional
    string

    Project ref

  • cursor
    Optional
    string
  • limit
    Optional
    string
  • sort_by
    Optional
    enum
  • sort_order
    Optional
    enum

Response codes

  • 200
  • 500

List all user-id to role mappings for JIT access

get/v1/projects/{ref}/database/jit/list

Mappings of roles a user can assume in the project database

The fine-grained token must include the following permissions to access this endpoint:

  • database_jit_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] List applied migration versions

get/v1/projects/{ref}/database/migrations

Only available to selected partner OAuth apps

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_migrations_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Patch an existing entry in migration history

patch/v1/projects/{ref}/database/migrations/{version}

Only available to selected partner OAuth apps

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_migrations_write

Path parameters

  • ref
    Required
    string

    Project ref

  • version
    Required
    string

Body

  • name
    Optional
    string
  • rollback
    Optional
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Run a sql query as assistance_read_only_user

post/v1/projects/{ref}/database/query/read-only

All entity references must be schema qualified.

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_read

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • query
    Required
    string
  • parameters
    Optional
    Array<unknown>

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

[Beta] Remove a read replica

post/v1/projects/{ref}/read-replicas/remove

The fine-grained token must include the following permissions to access this endpoint:

  • infra_read_replicas_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • database_identifier
    Required
    string

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

Restores a PITR backup for a database

post/v1/projects/{ref}/database/backups/restore-pitr

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • backups_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • recovery_time_target_unix
    Required
    integer

Response codes

  • 201
  • 401
  • 403
  • 429

[Beta] Rollback database migrations and remove them from history table

delete/v1/projects/{ref}/database/migrations

Only available to selected partner OAuth apps

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_migrations_write

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • gte
    Required
    string

    Rollback migrations greater or equal to this version

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Run sql query

post/v1/projects/{ref}/database/query

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_write
  • or
  • database_read

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • query
    Required
    string
  • parameters
    Optional
    Array<unknown>
  • read_only
    Optional
    boolean

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

[Beta] Set up a read replica

post/v1/projects/{ref}/read-replicas/setup

The fine-grained token must include the following permissions to access this endpoint:

  • infra_read_replicas_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • read_replica_region
    Required
    enum

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

Updates the database password

patch/v1/projects/{ref}/database/password

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • password
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Updates a user mapping for JIT access

put/v1/projects/{ref}/database/jit

Modifies the roles that can be assumed and for how long

The fine-grained token must include the following permissions to access this endpoint:

  • database_jit_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • user_id
    Required
    string
  • roles
    Required
    Array<object>

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Update project's just-in-time access configuration.

put/v1/projects/{ref}/jit-access

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • state
    Required
    enum

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Updates project's supavisor config

patch/v1/projects/{ref}/config/database/pooler

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_pooling_config_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • default_pool_size
    Optional
    integer
  • pool_mode
    Optional
    enum

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Updates project's Postgres config

put/v1/projects/{ref}/config/database/postgres

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_config_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • effective_cache_size
    Optional
    string
  • logical_decoding_work_mem
    Optional
    string
  • maintenance_work_mem
    Optional
    string
  • track_activity_query_size
    Optional
    string
  • max_connections
    Optional
    integer
  • max_locks_per_transaction
    Optional
    integer
  • max_parallel_maintenance_workers
    Optional
    integer
  • max_parallel_workers
    Optional
    integer
  • max_parallel_workers_per_gather
    Optional
    integer
  • max_replication_slots
    Optional
    integer
  • max_slot_wal_keep_size
    Optional
    string
  • max_standby_archive_delay
    Optional
    string
  • max_standby_streaming_delay
    Optional
    string
  • max_wal_size
    Optional
    string
  • max_wal_senders
    Optional
    integer
  • max_worker_processes
    Optional
    integer
  • session_replication_role
    Optional
    enum
  • shared_buffers
    Optional
    string
  • statement_timeout
    Optional
    string
  • track_commit_timestamp
    Optional
    boolean
  • wal_keep_size
    Optional
    string
  • wal_sender_timeout
    Optional
    string
  • work_mem
    Optional
    string
  • checkpoint_timeout
    Optional
    string
  • hot_standby_feedback
    Optional
    boolean
  • restart_database
    Optional
    boolean

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Update project's SSL enforcement configuration.

put/v1/projects/{ref}/ssl-enforcement

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_ssl_config_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • requestedConfig
    Required
    object

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Upsert a database migration without applying

put/v1/projects/{ref}/database/migrations

Only available to selected partner OAuth apps

OAuth scopes

  • database:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_migrations_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • query
    Required
    string
  • name
    Optional
    string
  • rollback
    Optional
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Activates a custom hostname for a project.

post/v1/projects/{ref}/custom-hostname/activate

OAuth scopes

  • domains:write

The fine-grained token must include the following permissions to access this endpoint:

  • custom_domain_write

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

[Beta] Activates a vanity subdomain for a project.

post/v1/projects/{ref}/vanity-subdomain/activate

OAuth scopes

  • domains:write

The fine-grained token must include the following permissions to access this endpoint:

  • vanity_subdomain_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • vanity_subdomain
    Required
    string

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

[Beta] Checks vanity subdomain availability

post/v1/projects/{ref}/vanity-subdomain/check-availability

OAuth scopes

  • domains:write

The fine-grained token must include the following permissions to access this endpoint:

  • vanity_subdomain_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • vanity_subdomain
    Required
    string

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

[Beta] Deletes a project's vanity subdomain configuration

delete/v1/projects/{ref}/vanity-subdomain

OAuth scopes

  • domains:write

The fine-grained token must include the following permissions to access this endpoint:

  • vanity_subdomain_write

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Gets project's custom hostname config

get/v1/projects/{ref}/custom-hostname

OAuth scopes

  • domains:read

The fine-grained token must include the following permissions to access this endpoint:

  • custom_domain_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Gets current vanity subdomain config

get/v1/projects/{ref}/vanity-subdomain

OAuth scopes

  • domains:read

The fine-grained token must include the following permissions to access this endpoint:

  • vanity_subdomain_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Updates project's custom hostname configuration

post/v1/projects/{ref}/custom-hostname/initialize

OAuth scopes

  • domains:write

The fine-grained token must include the following permissions to access this endpoint:

  • custom_domain_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • custom_hostname
    Required
    string

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

[Beta] Attempts to verify the DNS configuration for project's custom hostname configuration

post/v1/projects/{ref}/custom-hostname/reverify

OAuth scopes

  • domains:write

The fine-grained token must include the following permissions to access this endpoint:

  • custom_domain_write

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

Bulk update functions

put/v1/projects/{ref}/functions

Bulk update functions. It will create a new function or replace existing. The operation is idempotent. NOTE: You will need to manually bump the version.

OAuth scopes

  • edge_functions:write

The fine-grained token must include the following permissions to access this endpoint:

  • edge_functions_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

Array of object

Response codes

  • 200
  • 401
  • 402
  • 403
  • 429
  • 500

Create a function
deprecated

post/v1/projects/{ref}/functions

This endpoint is deprecated - use the deploy endpoint. Creates a function and adds it to the specified project.

OAuth scopes

  • edge_functions:write

The fine-grained token must include the following permissions to access this endpoint:

  • edge_functions_write

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • slug
    Optional
    string
  • name
    Optional
    string
  • verify_jwt
    Optional
    boolean

    Boolean string, true or false

  • import_map
    Optional
    boolean

    Boolean string, true or false

  • entrypoint_path
    Optional
    string
  • import_map_path
    Optional
    string
  • ezbr_sha256
    Optional
    string

Body

string

Response codes

  • 201
  • 401
  • 402
  • 403
  • 429
  • 500

Delete a function

delete/v1/projects/{ref}/functions/{function_slug}

Deletes a function with the specified slug from the specified project.

OAuth scopes

  • edge_functions:write

The fine-grained token must include the following permissions to access this endpoint:

  • edge_functions_write

Path parameters

  • ref
    Required
    string

    Project ref

  • function_slug
    Required
    string

    Function slug

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Deploy a function

post/v1/projects/{ref}/functions/deploy

A new endpoint to deploy functions. It will create if function does not exist.

OAuth scopes

  • edge_functions:write

The fine-grained token must include the following permissions to access this endpoint:

  • edge_functions_write

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • slug
    Optional
    string
  • bundleOnly
    Optional
    boolean

    Boolean string, true or false

Body

  • file
    Optional
    Array<string>
  • metadata
    Required
    object

Response codes

  • 201
  • 401
  • 402
  • 403
  • 429
  • 500

Retrieve a function

get/v1/projects/{ref}/functions/{function_slug}

Retrieves a function with the specified slug and project.

OAuth scopes

  • edge_functions:read

The fine-grained token must include the following permissions to access this endpoint:

  • edge_functions_read

Path parameters

  • ref
    Required
    string

    Project ref

  • function_slug
    Required
    string

    Function slug

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Retrieve a function body

get/v1/projects/{ref}/functions/{function_slug}/body

Retrieves a function body for the specified slug and project.

OAuth scopes

  • edge_functions:read

The fine-grained token must include the following permissions to access this endpoint:

  • edge_functions_read

Path parameters

  • ref
    Required
    string

    Project ref

  • function_slug
    Required
    string

    Function slug

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

List all functions

get/v1/projects/{ref}/functions

Returns all functions you've previously added to the specified project.

OAuth scopes

  • edge_functions:read

The fine-grained token must include the following permissions to access this endpoint:

  • edge_functions_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Update a function

patch/v1/projects/{ref}/functions/{function_slug}

Updates a function with the specified slug and project.

OAuth scopes

  • edge_functions:write

The fine-grained token must include the following permissions to access this endpoint:

  • edge_functions_write

Path parameters

  • ref
    Required
    string

    Project ref

  • function_slug
    Required
    string

    Function slug

Query parameters

  • slug
    Optional
    string
  • name
    Optional
    string
  • verify_jwt
    Optional
    boolean

    Boolean string, true or false

  • import_map
    Optional
    boolean

    Boolean string, true or false

  • entrypoint_path
    Optional
    string
  • import_map_path
    Optional
    string
  • ezbr_sha256
    Optional
    string

Body

string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Count the number of action runs

head/v1/projects/{ref}/actions

Returns the total number of action runs of the specified project.

OAuth scopes

  • environment:read

The fine-grained token must include the following permissions to access this endpoint:

  • action_runs_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Create a database branch

post/v1/projects/{ref}/branches

Creates a database branch from the specified project.

OAuth scopes

  • environment:write

The fine-grained token must include the following permissions to access this endpoint:

  • branching_production_create
  • or
  • branching_development_create

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • branch_name
    Required
    string
  • git_branch
    Optional
    string
  • is_default
    Optional
    boolean
  • persistent
    Optional
    boolean
  • region
    Optional
    string
  • desired_instance_size
    Optional
    enum
  • release_channel
    Optional
    enum
  • postgres_engine
    Optional
    enum
  • secrets
    Optional
    object
  • with_data
    Optional
    boolean
  • notify_url
    Optional
    string

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

Delete a database branch

delete/v1/branches/{branch_id_or_ref}

Deletes the specified database branch. By default, deletes immediately. Use force=false to schedule deletion with 1-hour grace period (only when soft deletion is enabled).

OAuth scopes

  • environment:write

The fine-grained token must include the following permissions to access this endpoint:

  • branching_production_delete
  • or
  • branching_development_delete

Path parameters

  • branch_id_or_ref
    Required
    one of the following options

    Branch ID

Query parameters

  • force
    Optional
    boolean

    If set to false, schedule deletion with 1-hour grace period (only when soft deletion is enabled).

Response codes

  • 200
  • 500

[Beta] Diffs a database branch

get/v1/branches/{branch_id_or_ref}/diff

Diffs the specified database branch

OAuth scopes

  • environment:write

The fine-grained token must include the following permissions to access this endpoint:

  • branching_production_write
  • or
  • branching_development_write

Path parameters

  • branch_id_or_ref
    Required
    one of the following options

    Branch ID

Query parameters

  • included_schemas
    Optional
    string
  • pgdelta
    Optional
    boolean

    Use pg-delta instead of Migra for diffing when true

Response codes

  • 200
  • 500

Disables preview branching

delete/v1/projects/{ref}/branches

Disables preview branching for the specified project

OAuth scopes

  • environment:write

The fine-grained token must include the following permissions to access this endpoint:

  • branching_production_delete

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Get a database branch

get/v1/projects/{ref}/branches/{name}

Fetches the specified database branch by its name.

OAuth scopes

  • environment:read

The fine-grained token must include the following permissions to access this endpoint:

  • branching_production_read
  • or
  • branching_development_read

Path parameters

  • ref
    Required
    string

    Project ref

  • name
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Get database branch config

get/v1/branches/{branch_id_or_ref}

Fetches configurations of the specified database branch

OAuth scopes

  • environment:read

The fine-grained token must include the following permissions to access this endpoint:

  • branching_production_read
  • or
  • branching_development_read

Path parameters

  • branch_id_or_ref
    Required
    one of the following options

    Branch ID

Response codes

  • 200
  • 500

Get the status of an action run

get/v1/projects/{ref}/actions/{run_id}

Returns the current status of the specified action run.

OAuth scopes

  • environment:read

The fine-grained token must include the following permissions to access this endpoint:

  • action_runs_read

Path parameters

  • ref
    Required
    string

    Project ref

  • run_id
    Required
    string

    Action Run ID

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Get the logs of an action run

get/v1/projects/{ref}/actions/{run_id}/logs

Returns the logs from the specified action run.

OAuth scopes

  • environment:read

The fine-grained token must include the following permissions to access this endpoint:

  • action_runs_read

Path parameters

  • ref
    Required
    string

    Project ref

  • run_id
    Required
    string

    Action Run ID

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

List all action runs

get/v1/projects/{ref}/actions

Returns a paginated list of action runs of the specified project.

OAuth scopes

  • environment:read

The fine-grained token must include the following permissions to access this endpoint:

  • action_runs_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • offset
    Optional
    number
  • limit
    Optional
    number

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

List all database branches

get/v1/projects/{ref}/branches

Returns all database branches of the specified project.

OAuth scopes

  • environment:read

The fine-grained token must include the following permissions to access this endpoint:

  • branching_production_read
  • or
  • branching_development_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Merges a database branch

post/v1/branches/{branch_id_or_ref}/merge

Merges the specified database branch

OAuth scopes

  • environment:write

The fine-grained token must include the following permissions to access this endpoint:

  • branching_production_write
  • or
  • branching_development_write

Path parameters

  • branch_id_or_ref
    Required
    one of the following options

    Branch ID

Body

  • migration_version
    Optional
    string

Response codes

  • 201
  • 500

Pushes a database branch

post/v1/branches/{branch_id_or_ref}/push

Pushes the specified database branch

OAuth scopes

  • environment:write

The fine-grained token must include the following permissions to access this endpoint:

  • branching_production_write
  • or
  • branching_development_write

Path parameters

  • branch_id_or_ref
    Required
    one of the following options

    Branch ID

Body

  • migration_version
    Optional
    string

Response codes

  • 201
  • 500

Resets a database branch

post/v1/branches/{branch_id_or_ref}/reset

Resets the specified database branch

OAuth scopes

  • environment:write

The fine-grained token must include the following permissions to access this endpoint:

  • branching_production_write
  • or
  • branching_development_write

Path parameters

  • branch_id_or_ref
    Required
    one of the following options

    Branch ID

Body

  • migration_version
    Optional
    string

Response codes

  • 201
  • 500

Restore a scheduled branch deletion

post/v1/branches/{branch_id_or_ref}/restore

Cancels scheduled deletion and restores the branch to active state

OAuth scopes

  • environment:write

The fine-grained token must include the following permissions to access this endpoint:

  • branching_production_write
  • or
  • branching_development_write

Path parameters

  • branch_id_or_ref
    Required
    one of the following options

    Branch ID

Response codes

  • 200
  • 500

Update database branch config

patch/v1/branches/{branch_id_or_ref}

Updates the configuration of the specified database branch

OAuth scopes

  • environment:write

The fine-grained token must include the following permissions to access this endpoint:

  • branching_production_write
  • or
  • branching_development_write

Path parameters

  • branch_id_or_ref
    Required
    one of the following options

    Branch ID

Body

  • branch_name
    Optional
    string
  • git_branch
    Optional
    string
  • reset_on_push
    Optional
    Deprecatedboolean
  • persistent
    Optional
    boolean
  • status
    Optional
    enum
  • request_review
    Optional
    boolean
  • notify_url
    Optional
    string

Response codes

  • 200
  • 500

Update the status of an action run

patch/v1/projects/{ref}/actions/{run_id}/status

Updates the status of an ongoing action run.

OAuth scopes

  • environment:write

The fine-grained token must include the following permissions to access this endpoint:

  • action_runs_write

Path parameters

  • ref
    Required
    string

    Project ref

  • run_id
    Required
    string

    Action Run ID

Body

  • clone
    Optional
    enum
  • pull
    Optional
    enum
  • health
    Optional
    enum
  • configure
    Optional
    enum
  • migrate
    Optional
    enum
  • seed
    Optional
    enum
  • deploy
    Optional
    enum

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Authorize user through oauth

get/v1/oauth/authorize

Query parameters

  • client_id
    Required
    string
  • response_type
    Required
    enum
  • redirect_uri
    Required
    string
  • scope
    Optional
    string
  • state
    Optional
    string
  • response_mode
    Optional
    string
  • code_challenge
    Optional
    string
  • code_challenge_method
    Optional
    enum
  • organization_slug
    Optional
    string

    Organization slug

  • resource
    Optional
    string

    Resource indicator for MCP (Model Context Protocol) clients

Response codes

  • 204

[Beta] Exchange auth code for user's access and refresh token

post/v1/oauth/token

Body

  • grant_type
    Optional
    enum
  • client_id
    Optional
    string
  • client_secret
    Optional
    string
  • code
    Optional
    string
  • code_verifier
    Optional
    string
  • redirect_uri
    Optional
    string
  • refresh_token
    Optional
    string
  • resource
    Optional
    string
  • scope
    Optional
    string

Response codes

  • 201

Authorize user through oauth and claim a project

get/v1/oauth/authorize/project-claim

Initiates the OAuth authorization flow for the specified provider. After successful authentication, the user can claim ownership of the specified project.

The fine-grained token must include the following permissions to access this endpoint:

  • organization_admin_write
  • project_admin_write

Query parameters

  • project_ref
    Required
    string

    Project ref

  • client_id
    Required
    string
  • response_type
    Required
    enum
  • redirect_uri
    Required
    string
  • state
    Optional
    string
  • response_mode
    Optional
    string
  • code_challenge
    Optional
    string
  • code_challenge_method
    Optional
    enum

Response codes

  • 204

[Beta] Revoke oauth app authorization and it's corresponding tokens

post/v1/oauth/revoke

Body

  • client_id
    Required
    string
  • client_secret
    Required
    string
  • refresh_token
    Required
    string

Response codes

  • 204

Create an organization

post/v1/organizations

The fine-grained token must include the following permissions to access this endpoint:

  • organizations_create

Body

  • name
    Required
    string

Response codes

  • 201
  • 500

Gets information about the organization

get/v1/organizations/{slug}

OAuth scopes

  • organizations:read

The fine-grained token must include the following permissions to access this endpoint:

  • organization_admin_read

Path parameters

  • slug
    Required
    string

    Organization slug

Response codes

  • 200
  • 401
  • 403
  • 429

List all organizations

get/v1/organizations

Returns a list of organizations that you currently belong to.

OAuth scopes

  • organizations:read

The fine-grained token must include the following permissions to access this endpoint:

  • organizations_read

Response codes

  • 200
  • 500

List members of an organization

get/v1/organizations/{slug}/members

OAuth scopes

  • organizations:read

The fine-grained token must include the following permissions to access this endpoint:

  • members_read

Path parameters

  • slug
    Required
    string

    Organization slug

Response codes

  • 200

Cancels the given project restoration

post/v1/projects/{ref}/restore/cancel

OAuth scopes

  • projects:write

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_write

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

Create a project

post/v1/projects

OAuth scopes

  • projects:write

The fine-grained token must include the following permissions to access this endpoint:

  • organization_projects_create

Body

  • db_pass
    Required
    string
  • name
    Required
    string
  • organization_id
    Optional
    Deprecatedstring
  • organization_slug
    Required
    string
  • plan
    Optional
    Deprecatedenum
  • region
    Optional
    Deprecatedenum
  • region_selection
    Optional
    one of the following options
  • kps_enabled
    Optional
    Deprecatedboolean
  • desired_instance_size
    Optional
    enum
  • template_url
    Optional
    string
  • release_channel
    Optional
    Deprecatedenum
  • postgres_engine
    Optional
    Deprecatedenum

Response codes

  • 201

Deletes the given project

delete/v1/projects/{ref}

OAuth scopes

  • projects:write

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_write

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

[Beta] Remove network bans.

delete/v1/projects/{ref}/network-bans

OAuth scopes

  • projects:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_network_bans_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • ipv4_addresses
    Required
    Array<string>
  • requester_ip
    Optional
    boolean
  • identifier
    Optional
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Gets all projects for the given organization

get/v1/organizations/{slug}/projects

Returns a paginated list of projects for the specified organization.

This endpoint uses offset-based pagination. Use the offset parameter to skip a number of projects and the limit parameter to control the number of projects returned per page.

The fine-grained token must include the following permissions to access this endpoint:

  • organization_projects_read

Path parameters

  • slug
    Required
    string

    Organization slug

Query parameters

  • offset
    Optional
    integer

    Number of projects to skip

  • limit
    Optional
    integer

    Number of projects to return per page

  • search
    Optional
    string

    Search projects by name

  • sort
    Optional
    enum

    Sort order for projects

  • statuses
    Optional
    string

    A comma-separated list of project statuses to filter by.

    The following values are supported: ACTIVE_HEALTHY, INACTIVE.

Response codes

  • 200
  • 500

[Beta] Gets the list of available regions that can be used for a new project

get/v1/projects/available-regions

OAuth scopes

  • organizations:read

Query parameters

  • organization_slug
    Required
    string

    Slug of your organization

  • continent
    Optional
    enum

    Continent code to determine regional recommendations: NA (North America), SA (South America), EU (Europe), AF (Africa), AS (Asia), OC (Oceania), AN (Antarctica)

  • desired_instance_size
    Optional
    enum

    Desired instance size

Response codes

  • 200

Get database disk attributes

get/v1/projects/{ref}/config/disk

The fine-grained token must include the following permissions to access this endpoint:

  • infra_disk_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Get disk utilization

get/v1/projects/{ref}/config/disk/util

The fine-grained token must include the following permissions to access this endpoint:

  • infra_disk_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Gets project's network restrictions

get/v1/projects/{ref}/network-restrictions

OAuth scopes

  • projects:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_network_restrictions_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Returns the project's eligibility for upgrades

get/v1/projects/{ref}/upgrade/eligibility

OAuth scopes

  • projects:read

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_read
  • database_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Gets the latest status of the project's upgrade

get/v1/projects/{ref}/upgrade/status

OAuth scopes

  • projects:read

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_read
  • database_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • tracking_id
    Optional
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Gets a specific project that belongs to the authenticated user

get/v1/projects/{ref}

OAuth scopes

  • projects:read

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Gets project disk autoscale config

get/v1/projects/{ref}/config/disk/autoscale

The fine-grained token must include the following permissions to access this endpoint:

  • infra_disk_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Gets project's service health status

get/v1/projects/{ref}/health

OAuth scopes

  • projects:read

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • services
    Required
    Array<enum>
  • timeout_ms
    Optional
    integer

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Gets project's network bans

post/v1/projects/{ref}/network-bans/retrieve

OAuth scopes

  • projects:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_network_bans_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

[Beta] Gets project's network bans with additional information about which databases they affect

post/v1/projects/{ref}/network-bans/retrieve/enriched

OAuth scopes

  • projects:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_network_bans_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

List all projects

get/v1/projects

Returns a list of all projects you've previously created.

Use /v1/organizations/{slug}/projects instead when possible to get more precise results and pagination support.

OAuth scopes

  • projects:read

The fine-grained token must include the following permissions to access this endpoint:

  • projects_read

Response codes

  • 200

Lists available restore versions for the given project

get/v1/projects/{ref}/restore

OAuth scopes

  • projects:read

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

Modify database disk

post/v1/projects/{ref}/config/disk

The fine-grained token must include the following permissions to access this endpoint:

  • infra_disk_config_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • attributes
    Required
    one of the following options

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

[Alpha] Updates project's network restrictions by adding or removing CIDRs

patch/v1/projects/{ref}/network-restrictions

OAuth scopes

  • projects:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_network_restrictions_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • add
    Optional
    object
  • remove
    Optional
    object

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Pauses the given project

post/v1/projects/{ref}/pause

OAuth scopes

  • projects:write

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_write

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

Restores the given project

post/v1/projects/{ref}/restore

OAuth scopes

  • projects:write

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_write

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

Updates the given project

patch/v1/projects/{ref}

OAuth scopes

  • projects:write

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • name
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Updates project's network restrictions

post/v1/projects/{ref}/network-restrictions/apply

OAuth scopes

  • projects:write

The fine-grained token must include the following permissions to access this endpoint:

  • database_network_restrictions_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • dbAllowedCidrs
    Optional
    Array<string>
  • dbAllowedCidrsV6
    Optional
    Array<string>

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

[Beta] Upgrades the project's Postgres version

post/v1/projects/{ref}/upgrade

OAuth scopes

  • projects:write

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_write
  • database_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • target_version
    Required
    string
  • release_channel
    Optional
    enum

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

Gets realtime configuration

get/v1/projects/{ref}/config/realtime

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

Shutdowns realtime connections for a project

post/v1/projects/{ref}/config/realtime/shutdown

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 204
  • 401
  • 403
  • 404
  • 429

Updates realtime configuration

patch/v1/projects/{ref}/config/realtime

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • private_only
    Optional
    boolean
  • connection_pool
    Optional
    integer
  • max_concurrent_users
    Optional
    integer
  • max_events_per_second
    Optional
    integer
  • max_bytes_per_second
    Optional
    integer
  • max_channels_per_client
    Optional
    integer
  • max_joins_per_second
    Optional
    integer
  • max_presence_events_per_second
    Optional
    integer
  • max_payload_size_in_kb
    Optional
    integer
  • suspend
    Optional
    boolean

Response codes

  • 204
  • 401
  • 403
  • 429

Gets project's postgrest config

get/v1/projects/{ref}/postgrest

OAuth scopes

  • rest:read

The fine-grained token must include the following permissions to access this endpoint:

  • data_api_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Updates project's postgrest config

patch/v1/projects/{ref}/postgrest

OAuth scopes

  • rest:write

The fine-grained token must include the following permissions to access this endpoint:

  • data_api_config_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • db_extra_search_path
    Optional
    string
  • db_schema
    Optional
    string
  • max_rows
    Optional
    integer
  • db_pool
    Optional
    integer

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Bulk create secrets

post/v1/projects/{ref}/secrets

Creates multiple secrets and adds them to the specified project.

OAuth scopes

  • secrets:write

The fine-grained token must include the following permissions to access this endpoint:

  • edge_functions_secrets_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

Array of object

Response codes

  • 201
  • 401
  • 403
  • 429
  • 500

Bulk delete secrets

delete/v1/projects/{ref}/secrets

Deletes all secrets with the given names from the specified project

OAuth scopes

  • secrets:write

The fine-grained token must include the following permissions to access this endpoint:

  • edge_functions_secrets_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

Array of string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Creates a new API key for the project

post/v1/projects/{ref}/api-keys

OAuth scopes

  • secrets:write

The fine-grained token must include the following permissions to access this endpoint:

  • api_gateway_keys_write

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • reveal
    Optional
    boolean

    Boolean string, true or false

Body

  • type
    Required
    enum
  • name
    Required
    string
  • description
    Optional
    string
  • secret_jwt_template
    Optional
    object

Response codes

  • 201
  • 401
  • 403
  • 429

Deletes an API key for the project

delete/v1/projects/{ref}/api-keys/{id}

OAuth scopes

  • secrets:write

The fine-grained token must include the following permissions to access this endpoint:

  • api_gateway_keys_write

Path parameters

  • ref
    Required
    string

    Project ref

  • id
    Required
    string

Query parameters

  • reveal
    Optional
    boolean

    Boolean string, true or false

  • was_compromised
    Optional
    boolean

    Boolean string, true or false

  • reason
    Optional
    string

Response codes

  • 200
  • 401
  • 403
  • 429

[Beta] Gets project's pgsodium config

get/v1/projects/{ref}/pgsodium

OAuth scopes

  • secrets:read

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_write

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Get API key

get/v1/projects/{ref}/api-keys/{id}

OAuth scopes

  • secrets:read

The fine-grained token must include the following permissions to access this endpoint:

  • api_gateway_keys_read

Path parameters

  • ref
    Required
    string

    Project ref

  • id
    Required
    string

Query parameters

  • reveal
    Optional
    boolean

    Boolean string, true or false

Response codes

  • 200
  • 401
  • 403
  • 429

Get project api keys

get/v1/projects/{ref}/api-keys

OAuth scopes

  • secrets:read

The fine-grained token must include the following permissions to access this endpoint:

  • api_gateway_keys_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • reveal
    Optional
    boolean

    Boolean string, true or false

Response codes

  • 200
  • 401
  • 403
  • 429

Check whether JWT based legacy (anon, service_role) API keys are enabled. This API endpoint will be removed in the future, check for HTTP 404 Not Found.

get/v1/projects/{ref}/api-keys/legacy

OAuth scopes

  • secrets:read

The fine-grained token must include the following permissions to access this endpoint:

  • api_gateway_keys_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

List all secrets

get/v1/projects/{ref}/secrets

Returns all secrets you've previously added to the specified project.

OAuth scopes

  • secrets:read

The fine-grained token must include the following permissions to access this endpoint:

  • edge_functions_secrets_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

[Beta] Updates project's pgsodium config. Updating the root_key can cause all data encrypted with the older key to become inaccessible.

put/v1/projects/{ref}/pgsodium

OAuth scopes

  • secrets:write

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • root_key
    Required
    string

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Updates an API key for the project

patch/v1/projects/{ref}/api-keys/{id}

OAuth scopes

  • secrets:write

The fine-grained token must include the following permissions to access this endpoint:

  • api_gateway_keys_write

Path parameters

  • ref
    Required
    string

    Project ref

  • id
    Required
    string

Query parameters

  • reveal
    Optional
    boolean

    Boolean string, true or false

Body

  • name
    Optional
    string
  • description
    Optional
    string
  • secret_jwt_template
    Optional
    object

Response codes

  • 200
  • 401
  • 403
  • 429

Disable or re-enable JWT based legacy (anon, service_role) API keys. This API endpoint will be removed in the future, check for HTTP 404 Not Found.

put/v1/projects/{ref}/api-keys/legacy

OAuth scopes

  • secrets:write

The fine-grained token must include the following permissions to access this endpoint:

  • api_gateway_keys_write

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • enabled
    Required
    boolean

    Boolean string, true or false

Response codes

  • 200
  • 401
  • 403
  • 429

Gets project's storage config

get/v1/projects/{ref}/config/storage

The fine-grained token must include the following permissions to access this endpoint:

  • storage_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Lists all buckets

get/v1/projects/{ref}/storage/buckets

OAuth scopes

  • storage:read

The fine-grained token must include the following permissions to access this endpoint:

  • storage_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Updates project's storage config

patch/v1/projects/{ref}/config/storage

The fine-grained token must include the following permissions to access this endpoint:

  • storage_config_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • fileSizeLimit
    Optional
    integer
  • features
    Optional
    object
  • external
    Optional
    object

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500