Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit115bb26

Browse files
committed
Update codefresh-api.md
Updated scopes list for pipelines with full access
1 parent276bc4e commit115bb26

File tree

1 file changed

+149
-0
lines changed

1 file changed

+149
-0
lines changed

‎_docs/integrations/codefresh-api.md‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,155 @@ The following resources can be targeted with the API:
9393

9494
The scopes available for each resource differ according to the type of resource.
9595

96+
{::nomarkdown}
97+
98+
<tableclass="table table-bordered table-hover">
99+
<thead>
100+
<tr>
101+
<th>Entity</th>
102+
<th>Access Level</th>
103+
<th>Endpoints</th>
104+
</tr>
105+
</thead>
106+
<tbody>
107+
<tr>
108+
<td rowspan="6">Pipeline</td>
109+
<td>Full access</td>
110+
<td>
111+
Approve workflow defined by ID that is pending approval
112+
Deny approval for workflow that is pending approval<br>
113+
114+
115+
116+
Get list of pipelines<br>
117+
Create a pipeline<br>
118+
Get list of incorrectly configured triggers for pipelines in account<br>
119+
Resolve incorrectly configured triggers for pipelines in account<br>
120+
121+
Get list of pipelines according to the query filters.
122+
Create a template from an existing pipeline.
123+
Set an existing pipeline as a template.
124+
Verify that account has at least one pipeline (internal endpoint)
125+
Get list of tags if any, assigned to pipelines.
126+
Get list of pipelines with the tag defined.
127+
Extract variables from the YAML based on the defined URL.
128+
Run new builds/restart builds for pipelines.
129+
Run pipeline.
130+
Run pipeline by name or ID.
131+
Run specified pipeline in debug mode and get ID of new pipeline created.
132+
133+
Enable debug mode for existing build by ID.
134+
Check if debug is enabled for existing build by ID.
135+
Restart build by ID.
136+
Restart a build in debug mode by ID.
137+
Get list of triggers for pipeline by ID.
138+
Replace existing pipeline by name or ID with the new payload.
139+
Delete pipeline by name or ID.
140+
Get project variables for pipeline by name or ID.
141+
Assign an execution context to pipeline by name or ID, with the execution context as payload.
142+
Delete or unassign the execution context assigned to a pipeline by ID or name.
143+
Get a preview of input variables and options for a pipeline execution by pipeline name and trigger name or ID.
144+
145+
146+
Validate YAML (internal endpoint)
147+
Test YAML from URL (internal endpoint)
148+
Get deploy images (internal endpoint)
149+
Clone variable by name from defined pipeline (internal endpoint)
150+
Verify pipeline trigger (internal endpoint)
151+
Extract variables (internal endpoint)
152+
Get volume image (internal endpoint)
153+
154+
155+
156+
157+
158+
159+
160+
161+
162+
- post -- /pipelines/analyze<br>
163+
- post -- /pipelines/run<br>
164+
- get -- /pipelines/projects/all<br>
165+
- 'post -- /pipelines/{name}'<br>
166+
167+
</td>
168+
</tr>
169+
<tr>
170+
<td>Read access</td>
171+
<td>
172+
- get -- /pipelines<br>
173+
- get -- /pipelines/invalidTriggers<br>
174+
- get -- /pipelines/triggers<br>
175+
- get -- /pipelines/templates<br>
176+
- get -- /pipelines/exist<br>
177+
- get -- /pipelines/labels<br>
178+
- 'get -- /pipelines/labels/{label}'<br>
179+
- get -- /pipelines/names<br>
180+
- get -- /pipelines/utils/extractVariables<br>
181+
- get -- /pipelines/yaml/test-url<br>
182+
- get -- /pipelines/templates/deploy-images<br>
183+
- get -- /pipelines/projects/all<br>
184+
- 'get -- /pipelines/{name}'<br>
185+
- 'get -- /pipelines/{name}/project-vars'<br>
186+
- 'get -- /pipelines/{name}/extractVariables'<br>
187+
- 'get -- /pipelines/{name}/volume-image'<br>
188+
</td>
189+
</tr>
190+
<tr>
191+
<td>Write access</td>
192+
<td>
193+
Clone named variables from specified pipeline<br>
194+
Update pipeline with specified name
195+
Delete pipeline with specified name
196+
Create pipeline
197+
- 'put -- /pipelines/clone/variables/{name}/{originPipelineName}'<br>
198+
- 'put -- /pipelines/{name}'<br>
199+
- 'delete -- /pipelines/{name}'<br>
200+
- 'post -- /pipelines/{name}'<br>
201+
- 'delete -- /pipelines/{name}/execution-context'<br>
202+
- 'post -- /pipelines/{name}/triggers/{triggerId}/verify'<br>
203+
</td>
204+
</tr>
205+
<tr>
206+
<td>Approve access</td>
207+
<td>
208+
- 'get -- /workflow/{workflowId}/pending-approval/approve'<br>
209+
- 'get -- /workflow/{workflowId}/pending-approval/deny'<br>
210+
</td>
211+
</tr>
212+
<tr>
213+
<td>Debug access</td>
214+
<td>
215+
- 'post -- /pipelines/debug/{name}'<br>
216+
</td>
217+
</tr>
218+
<tr>
219+
<td>Run</td>
220+
<td>
221+
- 'post -- /pipelines/run/{name}'<br>
222+
- 'get -- /pipelines/{name}/preview-run-input'<br>
223+
</td>
224+
</tr>
225+
<tr>
226+
<td>Assign</td>
227+
<td>
228+
- 'patch -- /pipelines/{name}/execution-context'<br>
229+
</td>
230+
</tr>
231+
</tbody>
232+
</table>
233+
234+
235+
236+
237+
238+
{:/}
239+
240+
241+
242+
243+
244+
96245

97246
##Using the API Key with the Codefresh CLI
98247

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp