mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
feat: completed docs for to be depreciated api endpoints
This commit is contained in:
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Create"
|
||||
openapi: "POST /api/v1/workspace/{workspaceId}/environments"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Delete"
|
||||
openapi: "DELETE /api/v1/workspace/{workspaceId}/environments/{id}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Update"
|
||||
openapi: "PATCH /api/v1/workspace/{workspaceId}/environments/{id}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Create"
|
||||
openapi: "POST /api/v1/folders"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Delete"
|
||||
openapi: "DELETE /api/v1/folders/{folderIdOrName}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get by ID"
|
||||
openapi: "GET /api/v1/folders/{id}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "List"
|
||||
openapi: "GET /api/v1/folders"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Update"
|
||||
openapi: "PATCH /api/v1/folders/{folderId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Create Project Membership"
|
||||
openapi: "POST /api/v2/workspace/{projectId}/groups/{groupIdOrName}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Delete Project Membership"
|
||||
openapi: "DELETE /api/v2/workspace/{projectId}/groups/{groupId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get Project Membership"
|
||||
openapi: "GET /api/v2/workspace/{projectId}/groups/{groupId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "List Project Memberships"
|
||||
openapi: "GET /api/v2/workspace/{projectId}/groups"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Update Project Membership"
|
||||
openapi: "PATCH /api/v2/workspace/{projectId}/groups/{groupId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Create Identity Membership"
|
||||
openapi: "POST /api/v2/workspace/{projectId}/identity-memberships/{identityId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Delete Identity Membership"
|
||||
openapi: "DELETE /api/v2/workspace/{projectId}/identity-memberships/{identityId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get Identity by ID"
|
||||
openapi: "GET /api/v2/workspace/{projectId}/identity-memberships/{identityId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "List Identity Memberships"
|
||||
openapi: "GET /api/v2/workspace/{projectId}/identity-memberships"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Update Identity Membership"
|
||||
openapi: "PATCH /api/v2/workspace/{projectId}/identity-memberships/{identityId}"
|
||||
---
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "Create"
|
||||
openapi: "POST /api/v2/workspace/{projectId}/roles"
|
||||
---
|
||||
|
||||
<Note>
|
||||
You can read more about the permissions field in the [permissions
|
||||
documentation](/internals/permissions).
|
||||
</Note>
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Delete"
|
||||
openapi: "DELETE /api/v2/workspace/{projectId}/roles/{roleId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get By Slug"
|
||||
openapi: "GET /api/v2/workspace/{projectId}/roles/slug/{roleSlug}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "List"
|
||||
openapi: "GET /api/v2/workspace/{projectId}/roles"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Update"
|
||||
openapi: "PATCH /api/v2/workspace/{projectId}/roles/{roleId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Delete User Membership"
|
||||
openapi: "DELETE /api/v1/workspace/{workspaceId}/memberships/{membershipId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get By Username"
|
||||
openapi: "POST /api/v1/workspace/{workspaceId}/memberships/details"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get User Memberships"
|
||||
openapi: "GET /api/v1/workspace/{workspaceId}/memberships"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Update User Membership"
|
||||
openapi: "PATCH /api/v1/workspace/{workspaceId}/memberships/{membershipId}"
|
||||
---
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Get Project"
|
||||
openapi: "GET /api/v1/workspace/{workspaceId}"
|
||||
---
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Update Project"
|
||||
openapi: "PATCH /api/v1/workspace/{workspaceId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Create"
|
||||
openapi: "POST /api/v1/secret-imports"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Delete"
|
||||
openapi: "DELETE /api/v1/secret-imports/{secretImportId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "List"
|
||||
openapi: "GET /api/v1/secret-imports"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Update"
|
||||
openapi: "PATCH /api/v1/secret-imports/{secretImportId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Create"
|
||||
openapi: "POST /api/v1/workspace/{projectId}/tags"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Delete"
|
||||
openapi: "DELETE /api/v1/workspace/{projectId}/tags/{tagId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get By ID"
|
||||
openapi: "GET /api/v1/workspace/{projectId}/tags/{tagId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get By Slug"
|
||||
openapi: "GET /api/v1/workspace/{projectId}/tags/slug/{tagSlug}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "List"
|
||||
openapi: "GET /api/v1/workspace/{projectId}/tags"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Update"
|
||||
openapi: "PATCH /api/v1/workspace/{projectId}/tags/{tagId}"
|
||||
---
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Bulk Create"
|
||||
openapi: "POST /api/v3/secrets/batch/raw"
|
||||
---
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Create"
|
||||
openapi: "POST /api/v3/secrets/raw/{secretName}"
|
||||
---
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Bulk Delete"
|
||||
openapi: "DELETE /api/v3/secrets/batch/raw"
|
||||
---
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Delete"
|
||||
openapi: "DELETE /api/v3/secrets/raw/{secretName}"
|
||||
---
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "List"
|
||||
openapi: "GET /api/v3/secrets/raw"
|
||||
---
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Retrieve"
|
||||
openapi: "GET /api/v3/secrets/raw/{secretName}"
|
||||
---
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: "Bulk Update"
|
||||
openapi: "PATCH /api/v3/secrets/batch/raw"
|
||||
---
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Update"
|
||||
openapi: "PATCH /api/v3/secrets/raw/{secretName}"
|
||||
---
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Create"
|
||||
openapi: "POST /api/v1/workspace/{workspaceId}/environments"
|
||||
openapi: "POST /api/v1/projects/{projectId}/environments"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Delete"
|
||||
openapi: "DELETE /api/v1/workspace/{workspaceId}/environments/{id}"
|
||||
openapi: "DELETE /api/v1/projects/{projectId}/environments/{id}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Update"
|
||||
openapi: "PATCH /api/v1/workspace/{workspaceId}/environments/{id}"
|
||||
openapi: "PATCH /api/v1/projects/{projectId}/environments/{id}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Create"
|
||||
openapi: "POST /api/v1/folders"
|
||||
openapi: "POST /api/v2/folders"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Delete"
|
||||
openapi: "DELETE /api/v1/folders/{folderIdOrName}"
|
||||
openapi: "DELETE /api/v2/folders/{folderIdOrName}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Get by ID"
|
||||
openapi: "GET /api/v1/folders/{id}"
|
||||
openapi: "GET /api/v2/folders/{id}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "List"
|
||||
openapi: "GET /api/v1/folders"
|
||||
openapi: "GET /api/v2/folders"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Update"
|
||||
openapi: "PATCH /api/v1/folders/{folderId}"
|
||||
openapi: "PATCH /api/v2/folders/{folderId}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Create Project Membership"
|
||||
openapi: "POST /api/v2/workspace/{projectId}/groups/{groupIdOrName}"
|
||||
openapi: "POST /api/v1/projects/{projectId}/groups/{groupIdOrName}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Delete Project Membership"
|
||||
openapi: "DELETE /api/v2/workspace/{projectId}/groups/{groupId}"
|
||||
openapi: "DELETE /api/v1/projects/{projectId}/groups/{groupId}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Get Project Membership"
|
||||
openapi: "GET /api/v2/workspace/{projectId}/groups/{groupId}"
|
||||
openapi: "GET /api/v1/projects/{projectId}/groups/{groupId}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "List Project Memberships"
|
||||
openapi: "GET /api/v2/workspace/{projectId}/groups"
|
||||
openapi: "GET /api/v1/projects/{projectId}/groups"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Update Project Membership"
|
||||
openapi: "PATCH /api/v2/workspace/{projectId}/groups/{groupId}"
|
||||
openapi: "PATCH /api/v1/projects/{projectId}/groups/{groupId}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Create Identity Membership"
|
||||
openapi: "POST /api/v2/workspace/{projectId}/identity-memberships/{identityId}"
|
||||
openapi: "POST /api/v1/projects/{projectId}/identity-memberships/{identityId}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Delete Identity Membership"
|
||||
openapi: "DELETE /api/v2/workspace/{projectId}/identity-memberships/{identityId}"
|
||||
openapi: "DELETE /api/v1/projects/{projectId}/identity-memberships/{identityId}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Get Identity by ID"
|
||||
openapi: "GET /api/v2/workspace/{projectId}/identity-memberships/{identityId}"
|
||||
openapi: "GET /api/v1/projects/{projectId}/identity-memberships/{identityId}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "List Identity Memberships"
|
||||
openapi: "GET /api/v2/workspace/{projectId}/identity-memberships"
|
||||
openapi: "GET /api/v1/projects/{projectId}/identity-memberships"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Update Identity Membership"
|
||||
openapi: "PATCH /api/v2/workspace/{projectId}/identity-memberships/{identityId}"
|
||||
openapi: "PATCH /api/v1/projects/{projectId}/identity-memberships/{identityId}"
|
||||
---
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
---
|
||||
title: "Create"
|
||||
openapi: "POST /api/v2/workspace/{projectId}/roles"
|
||||
openapi: "POST /api/v1/projects/{projectId}/roles"
|
||||
---
|
||||
|
||||
<Note>
|
||||
You can read more about the permissions field in the [permissions
|
||||
documentation](/internals/permissions).
|
||||
</Note>
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Delete"
|
||||
openapi: "DELETE /api/v2/workspace/{projectId}/roles/{roleId}"
|
||||
openapi: "DELETE /api/v1/projects/{projectId}/roles/{roleId}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Get By Slug"
|
||||
openapi: "GET /api/v2/workspace/{projectId}/roles/slug/{roleSlug}"
|
||||
openapi: "GET /api/v1/projects/{projectId}/roles/slug/{roleSlug}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "List"
|
||||
openapi: "GET /api/v2/workspace/{projectId}/roles"
|
||||
openapi: "GET /api/v1/projects/{projectId}/roles"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Update"
|
||||
openapi: "PATCH /api/v2/workspace/{projectId}/roles/{roleId}"
|
||||
openapi: "PATCH /api/v1/projects/{projectId}/roles/{roleId}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Delete User Membership"
|
||||
openapi: "DELETE /api/v1/workspace/{workspaceId}/memberships/{membershipId}"
|
||||
openapi: "DELETE /api/v1/projects/{projectId}/memberships/{membershipId}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Get By Username"
|
||||
openapi: "POST /api/v1/workspace/{workspaceId}/memberships/details"
|
||||
openapi: "POST /api/v1/projects/{projectId}/memberships/details"
|
||||
---
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Invite Member"
|
||||
openapi: "POST /api/v1/projects/{projectId}/memberships"
|
||||
---
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Get User Memberships"
|
||||
openapi: "GET /api/v1/workspace/{workspaceId}/memberships"
|
||||
openapi: "GET /api/v1/projects/{projectId}/memberships"
|
||||
---
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Remove Member"
|
||||
openapi: "DELETE /api/v1/projects/{projectId}/memberships"
|
||||
---
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Update User Membership"
|
||||
openapi: "PATCH /api/v1/workspace/{workspaceId}/memberships/{membershipId}"
|
||||
openapi: "PATCH /api/v1/projects/{projectId}/memberships/{membershipId}"
|
||||
---
|
||||
|
||||
4
docs/api-reference/endpoints/projects/create-project.mdx
Normal file
4
docs/api-reference/endpoints/projects/create-project.mdx
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Create Project"
|
||||
openapi: "POST /api/v1/projects"
|
||||
---
|
||||
8
docs/api-reference/endpoints/projects/delete-project.mdx
Normal file
8
docs/api-reference/endpoints/projects/delete-project.mdx
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Delete Project"
|
||||
openapi: "DELETE /api/v1/projects/{projectId}"
|
||||
---
|
||||
|
||||
<Warning>
|
||||
This operation is irreversible. All data associated with the project will be deleted. Please use with caution.
|
||||
</Warning>
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get Project By Slug"
|
||||
openapi: "GET /api/v1/projects/slug/{slug}"
|
||||
---
|
||||
4
docs/api-reference/endpoints/projects/get-project.mdx
Normal file
4
docs/api-reference/endpoints/projects/get-project.mdx
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get Project"
|
||||
openapi: "GET /api/v1/projects/{projectId}"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Roll Back to Snapshot"
|
||||
openapi: "POST /api/v1/secret-snapshot/{secretSnapshotId}/rollback"
|
||||
---
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Get Snapshots"
|
||||
openapi: "GET /api/v1/projects/{projectId}/secret-snapshots"
|
||||
---
|
||||
4
docs/api-reference/endpoints/projects/update-project.mdx
Normal file
4
docs/api-reference/endpoints/projects/update-project.mdx
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: "Update Project"
|
||||
openapi: "PATCH /api/v1/projects/{projectId}"
|
||||
---
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Create"
|
||||
openapi: "POST /api/v1/secret-imports"
|
||||
openapi: "POST /api/v2/secret-imports"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Delete"
|
||||
openapi: "DELETE /api/v1/secret-imports/{secretImportId}"
|
||||
openapi: "DELETE /api/v2/secret-imports/{secretImportId}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "List"
|
||||
openapi: "GET /api/v1/secret-imports"
|
||||
openapi: "GET /api/v2/secret-imports"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Update"
|
||||
openapi: "PATCH /api/v1/secret-imports/{secretImportId}"
|
||||
openapi: "PATCH /api/v2/secret-imports/{secretImportId}"
|
||||
---
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
---
|
||||
title: "Create"
|
||||
openapi: "POST /api/v1/workspace/{projectId}/tags"
|
||||
---
|
||||
openapi: "POST /api/v1/projects/{projectId}/tags"
|
||||
---
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user