API Reference/Management

Project Management

Overview

Using the project management APIs enables administrators to manage their projects utilizing a management key.

Management keys are generated from Company > Management Keys. These keys will be used within the bearer token. The format is <Project ID>:<Management Key>.

Use Cases

Project Management:

  1. Rename a project
  2. Export a project
  3. Import a project
  4. Clone a project
  5. Delete a project

Examples

Example - export and import projects

  1. Utilize the export project api endpoint to export a project
  2. Take the output from the export project api and pass to the import project api endpoint. Most of the time, you will export a project, then import to a different project, so ensure to update your project ID in the bearer for the import request.
Was this helpful?

Batch Delete Roles POST

### Delete roles in batch, using a valid management key. This API endpoint allows administrators to delete roles in batch. The endpoint takes the following one parameter: - roleNames (required) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`

Rename Project POST

### Rename a project utilizing a management key. This endpoint allows you to update the name of a project. The body only requires the `name` argument. ### See Also - See [Managing Environments](/customize/environments/) for details about managing environments. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`

On this page