diff --git a/_docs/integrations/codefresh-api.md b/_docs/integrations/codefresh-api.md index 65edeb1a0..34d7510c4 100644 --- a/_docs/integrations/codefresh-api.md +++ b/_docs/integrations/codefresh-api.md @@ -93,6 +93,155 @@ The following resources can be targeted with the API: The scopes available for each resource differ according to the type of resource. +{::nomarkdown} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EntityAccess LevelEndpoints
PipelineFull access + Approve workflow defined by ID that is pending approval + Deny approval for workflow that is pending approval
+ + + + Get list of pipelines
+ Create a pipeline
+ Get list of incorrectly configured triggers for pipelines in account
+ Resolve incorrectly configured triggers for pipelines in account
+ + Get list of pipelines according to the query filters. + Create a template from an existing pipeline. + Set an existing pipeline as a template. + Verify that account has at least one pipeline (internal endpoint) + Get list of tags if any, assigned to pipelines. + Get list of pipelines with the tag defined. + Extract variables from the YAML based on the defined URL. + Run new builds/restart builds for pipelines. + Run pipeline. + Run pipeline by name or ID. + Run specified pipeline in debug mode and get ID of new pipeline created. + + Enable debug mode for existing build by ID. + Check if debug is enabled for existing build by ID. + Restart build by ID. + Restart a build in debug mode by ID. + Get list of triggers for pipeline by ID. + Replace existing pipeline by name or ID with the new payload. + Delete pipeline by name or ID. + Get project variables for pipeline by name or ID. + Assign an execution context to pipeline by name or ID, with the execution context as payload. + Delete or unassign the execution context assigned to a pipeline by ID or name. + Get a preview of input variables and options for a pipeline execution by pipeline name and trigger name or ID. + + + Validate YAML (internal endpoint) + Test YAML from URL (internal endpoint) + Get deploy images (internal endpoint) + Clone variable by name from defined pipeline (internal endpoint) + Verify pipeline trigger (internal endpoint) + Extract variables (internal endpoint) + Get volume image (internal endpoint) + + + + + + + + + + - post -- /pipelines/analyze
+ - post -- /pipelines/run
+ - get -- /pipelines/projects/all
+ - 'post -- /pipelines/{name}'
+ +
Read access + - get -- /pipelines
+ - get -- /pipelines/invalidTriggers
+ - get -- /pipelines/triggers
+ - get -- /pipelines/templates
+ - get -- /pipelines/exist
+ - get -- /pipelines/labels
+ - 'get -- /pipelines/labels/{label}'
+ - get -- /pipelines/names
+ - get -- /pipelines/utils/extractVariables
+ - get -- /pipelines/yaml/test-url
+ - get -- /pipelines/templates/deploy-images
+ - get -- /pipelines/projects/all
+ - 'get -- /pipelines/{name}'
+ - 'get -- /pipelines/{name}/project-vars'
+ - 'get -- /pipelines/{name}/extractVariables'
+ - 'get -- /pipelines/{name}/volume-image'
+
Write access + Clone named variables from specified pipeline
+ Update pipeline with specified name + Delete pipeline with specified name + Create pipeline + - 'put -- /pipelines/clone/variables/{name}/{originPipelineName}'
+ - 'put -- /pipelines/{name}'
+ - 'delete -- /pipelines/{name}'
+ - 'post -- /pipelines/{name}'
+ - 'delete -- /pipelines/{name}/execution-context'
+ - 'post -- /pipelines/{name}/triggers/{triggerId}/verify'
+
Approve access + - 'get -- /workflow/{workflowId}/pending-approval/approve'
+ - 'get -- /workflow/{workflowId}/pending-approval/deny'
+
Debug access + - 'post -- /pipelines/debug/{name}'
+
Run + - 'post -- /pipelines/run/{name}'
+ - 'get -- /pipelines/{name}/preview-run-input'
+
Assign + - 'patch -- /pipelines/{name}/execution-context'
+
+ + + + + +{:/} + + + + + + ## Using the API Key with the Codefresh CLI