feat: create folders, environments, and projects
This commit is contained in:
69
README.md
69
README.md
@@ -432,3 +432,72 @@ const renewedLease = await client.dynamicSecrets().leases.renew(newLease.lease.i
|
||||
**Returns:**
|
||||
- `ApiV1DynamicSecretsLeasesLeaseIdDelete200Response`: The renewed lease response _(doesn't contain new credentials)_.
|
||||
|
||||
### `projects`
|
||||
|
||||
#### Create a new project
|
||||
|
||||
```typescript
|
||||
const project = await client.projects().create({
|
||||
projectName: "<name-of-project>",
|
||||
type: "secret-manager", // cert-manager, secret-manager, kms, ssh
|
||||
projectDescription: "<project-description>", // Optional
|
||||
slug: "<slug-of-project-to-create>", // Optional
|
||||
template: "<project-template-name>", // Optional
|
||||
kmsKeyId: "kms-key-id" // Optional
|
||||
});
|
||||
```
|
||||
|
||||
**Parameters:**
|
||||
- `projectName` (string): The name of the project to create.
|
||||
- `type` (string): The type of project to create. Valid options are `secret-manager`, `cert-manager`, `kms`, `ssh`
|
||||
- `projectDescription` (string): An optional description of the project to create.
|
||||
- `slug` (string): An optional slug for the project to create. If not provided, one will be generated automatically.
|
||||
- `template` (string): Optionally provide a project template name to use for creating this project.
|
||||
- `kmsKeyId` (string): The ID of the KMS key to use for the project. Will use the Infisical KMS by default.
|
||||
|
||||
**Returns:**
|
||||
- `ApiV1WorkspaceWorkspaceIdGet200ResponseWorkspace`: The project that was created.
|
||||
|
||||
### `environments`
|
||||
|
||||
#### Create a new environment
|
||||
|
||||
```typescript
|
||||
const environment = await client.environments().create({
|
||||
name: "Demo Environment",
|
||||
projectId: "<your-project-id>",
|
||||
slug: "demo-environment",
|
||||
position: 1 // Optional
|
||||
});
|
||||
```
|
||||
|
||||
**Parameters:**
|
||||
- `name` (string): The name of the environment to be created.
|
||||
- `projectId` (string): The ID of the project to create the environment within.
|
||||
- `slug`: (string): The slug of the environment to be created.
|
||||
- `position` (number): An optional position of the environment to be created. The position is used in the Infisical UI to display environments in order. Environments with the lowest position come first.
|
||||
|
||||
**Returns:**
|
||||
- `ApiV1WorkspaceWorkspaceIdEnvironmentsEnvIdGet200ResponseEnvironment`: The environment that was created.
|
||||
|
||||
#### Create a new folder
|
||||
|
||||
```typescript
|
||||
const folder = await client.folders().create({
|
||||
name: "<folder-name>",
|
||||
path: "<folder-path>",
|
||||
projectId: "<your-project-id>",
|
||||
environment: "<environment-slug>",
|
||||
description: "<folder-description>" // Optional
|
||||
});
|
||||
```
|
||||
|
||||
**Parameters:**
|
||||
- `name` (string): The name of the folder to create.
|
||||
- `path` (string): The path where of where to create the folder. Defaults to `/`, which is the root folder.
|
||||
- `projectId` (string): The ID of the project to create the folder within.
|
||||
- `environment` (string): The slug of the environment to create the folder within.
|
||||
- `description` (string): An optional folder description.
|
||||
|
||||
**Returns:**
|
||||
- `ApiV1FoldersPost200ResponseFolder`: The folder that was created.
|
||||
|
||||
Reference in New Issue
Block a user