Projects

Updates the name, description, websites, or consent settings of a project. Any field left out is unchanged. websites replaces the whole list; leaving out a website an audit uses answers 409, so delete that website with DELETE /v1/projects/{projectId}/websites/{websiteId} instead. A project without a Consent runtime takes its websites from its audits, so websites answers 409 there too. Renaming a project also changes its slug and dashboard URL. Requires projects.write and an admin or owner role. Removing branding requires a plan that includes it and otherwise answers 402 before anything changes.

patch/v1/projects/{projectId}

Request

  • Base URL
    https://api.inth.com
  • URL
    https://api.inth.com/v1/projects/{projectId}
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Project ID.

Request body

namestring

Project display name. Updating it also regenerates the project slug.

descriptionstring nullable
websitesstring[]

The project's websites, replacing the current list. Each is a domain (example.com), wildcard (*.example.com or *), IPv6 address in brackets, local address, or app origin (capacitor://localhost). Leaving out a website an audit uses answers 409.

Response

Updated project.

successtrue required

Changes

    • info

      added the new optional request property

    • info

      request property / deprecated

    • info

      response property data/consent/oneOf[ConsentSettings]/trustedOrigins deprecated

    • info

      added the required property / to the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the request property

    • warning

      added the new INSUFFICIENT_CREDITS enum value to the / response property for the response status

    • warning

      added the new INSUFFICIENT_CREDITS enum value to the / response property for the response status

    • warning

      added the new INSUFFICIENT_CREDITS enum value to the / response property for the response status

    • warning

      added the new INSUFFICIENT_CREDITS enum value to the / response property for the response status

    • warning

      added the new INSUFFICIENT_CREDITS enum value to the / response property for the response status

    • warning

      added the new INSUFFICIENT_CREDITS enum value to the / response property for the response status

    • warning

      added the new INSUFFICIENT_CREDITS enum value to the / response property for the response status

    • warning

      added the new INSUFFICIENT_CREDITS enum value to the / response property for the response status

    • warning

      added the new REPOSITORY_NOT_LINKED enum value to the / response property for the response status

    • warning

      added the new REPOSITORY_NOT_LINKED enum value to the / response property for the response status

    • warning

      added the new REPOSITORY_NOT_LINKED enum value to the / response property for the response status

    • warning

      added the new REPOSITORY_NOT_LINKED enum value to the / response property for the response status

    • warning

      added the new REPOSITORY_NOT_LINKED enum value to the / response property for the response status

    • warning

      added the new REPOSITORY_NOT_LINKED enum value to the / response property for the response status

    • warning

      added the new REPOSITORY_NOT_LINKED enum value to the / response property for the response status

    • warning

      added the new REPOSITORY_NOT_LINKED enum value to the / response property for the response status

    • warning

      added the new SCAN_IN_PROGRESS enum value to the / response property for the response status

    • warning

      added the new SCAN_IN_PROGRESS enum value to the / response property for the response status

    • warning

      added the new SCAN_IN_PROGRESS enum value to the / response property for the response status

    • warning

      added the new SCAN_IN_PROGRESS enum value to the / response property for the response status

    • warning

      added the new SCAN_IN_PROGRESS enum value to the / response property for the response status

    • warning

      added the new SCAN_IN_PROGRESS enum value to the / response property for the response status

    • warning

      added the new SCAN_IN_PROGRESS enum value to the / response property for the response status

    • warning

      added the new SCAN_IN_PROGRESS enum value to the / response property for the response status

    • warning

      added the new UNLOCK_REQUIRED enum value to the / response property for the response status

    • warning

      added the new UNLOCK_REQUIRED enum value to the / response property for the response status

    • warning

      added the new UNLOCK_REQUIRED enum value to the / response property for the response status

    • warning

      added the new UNLOCK_REQUIRED enum value to the / response property for the response status

    • warning

      added the new UNLOCK_REQUIRED enum value to the / response property for the response status

    • warning

      added the new UNLOCK_REQUIRED enum value to the / response property for the response status

    • warning

      added the new UNLOCK_REQUIRED enum value to the / response property for the response status

    • warning

      added the new UNLOCK_REQUIRED enum value to the / response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      removed the INSTANCE_LIMIT_REACHED enum value from the / response property for the response status

    • info

      removed the INSTANCE_LIMIT_REACHED enum value from the / response property for the response status

    • info

      removed the INSTANCE_LIMIT_REACHED enum value from the / response property for the response status

    • info

      removed the INSTANCE_LIMIT_REACHED enum value from the / response property for the response status

    • info

      removed the INSTANCE_LIMIT_REACHED enum value from the / response property for the response status

    • info

      removed the INSTANCE_LIMIT_REACHED enum value from the / response property for the response status

    • info

      removed the INSTANCE_LIMIT_REACHED enum value from the / response property for the response status

    • info

      removed the INSTANCE_LIMIT_REACHED enum value from the / response property for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status