Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
16613c2e
Commit
16613c2e
authored
Dec 14, 2021
by
Marcel Amirault
Committed by
Kati Paizee
Dec 14, 2021
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Sort and clean up api resources tables
parent
596fe508
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
140 additions
and
140 deletions
+140
-140
doc/api/api_resources.md
doc/api/api_resources.md
+140
-140
No files found.
doc/api/api_resources.md
View file @
16613c2e
...
...
@@ -23,7 +23,7 @@ See also:
The following API resources are available in the project context:
| Resource | Available endpoints |
|:--------------------------------------------------------------------
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------|
|:--------------------------------------------------------------------
----|:
--------------------|
|
[
Access requests
](
access_requests.md
)
|
`/projects/:id/access_requests`
(also available for groups) |
|
[
Access tokens
](
resource_access_tokens.md
)
|
`/projects/:id/access_tokens`
|
|
[
Award emoji
](
award_emoji.md
)
|
`/projects/:id/issues/.../award_emoji`
,
`/projects/:id/merge_requests/.../award_emoji`
,
`/projects/:id/snippets/.../award_emoji`
|
...
...
@@ -31,23 +31,23 @@ The following API resources are available in the project context:
|
[
Commits
](
commits.md
)
|
`/projects/:id/repository/commits`
,
`/projects/:id/statuses`
|
|
[
Container Registry
](
container_registry.md
)
|
`/projects/:id/registry/repositories`
|
|
[
Custom attributes
](
custom_attributes.md
)
|
`/projects/:id/custom_attributes`
(also available for groups and users) |
|
[
Debian distributions
](
packages/debian_project_distributions.md
)
|
`/projects/:id/debian_distributions`
(also available for groups) |
|
[
Dependencies
](
dependencies.md
)
**(ULTIMATE)**
|
`/projects/:id/dependencies`
|
|
[
Deploy keys
](
deploy_keys.md
)
|
`/projects/:id/deploy_keys`
(also available standalone) |
|
[
Freeze Periods
](
freeze_periods.md
)
|
`/projects/:id/freeze_periods`
|
|
[
Debian distributions
](
packages/debian_project_distributions.md
)
|
`/projects/:id/debian_distributions`
(also available for groups) |
|
[
Deployments
](
deployments.md
)
|
`/projects/:id/deployments`
|
|
[
Discussions
](
discussions.md
)
(
threaded
comments) |
`/projects/:id/issues/.../discussions`
,
`/projects/:id/snippets/.../discussions`
,
`/projects/:id/merge_requests/.../discussions`
,
`/projects/:id/commits/.../discussions`
(also available for groups) |
|
[
Environments
](
environments.md
)
|
`/projects/:id/environments`
|
|
[
Error Tracking
](
error_tracking.md
)
|
`/projects/:id/error_tracking/settings`
|
|
[
Events
](
events.md
)
|
`/projects/:id/events`
(also available for users and standalone) |
|
[
Feature Flags
](
feature_flags.md
)
|
`/projects/:id/feature_flags`
|
|
[
Feature Flag User Lists
](
feature_flag_user_lists.md
)
|
`/projects/:id/feature_flags_user_lists`
|
|
[
Feature Flags
](
feature_flags.md
)
|
`/projects/:id/feature_flags`
|
|
[
Freeze Periods
](
freeze_periods.md
)
|
`/projects/:id/freeze_periods`
|
|
[
Integrations
](
integrations.md
)
(
Formerly
"services"
)
|
`/projects/:id/integrations`
|
|
[
Invitations
](
invitations.md
)
|
`/projects/:id/invitations`
(also available for groups) |
|
[
Issues
](
issues.md
)
|
`/projects/:id/issues`
(also available for groups and standalone) |
|
[
Issues Statistics
](
issues_statistics.md
)
|
`/projects/:id/issues_statistics`
(also available for groups and standalone) |
|
[
Issue boards
](
boards.md
)
|
`/projects/:id/boards`
|
|
[
Issue links
](
issue_links.md
)
. |
`/projects/:id/issues/.../links`
|
|
[
Issue links
](
issue_links.md
)
|
`/projects/:id/issues/.../links`
|
|
[
Issues Statistics
](
issues_statistics.md
)
|
`/projects/:id/issues_statistics`
(also available for groups and standalone) |
|
[
Issues
](
issues.md
)
|
`/projects/:id/issues`
(also available for groups and standalone) |
|
[
Iterations
](
iterations.md
)
**(PREMIUM)**
|
`/projects/:id/iterations`
(also available for groups) |
|
[
Jobs
](
jobs.md
)
|
`/projects/:id/jobs`
,
`/projects/:id/pipelines/.../jobs`
|
|
[
Labels
](
labels.md
)
|
`/projects/:id/labels`
|
...
...
@@ -60,23 +60,24 @@ The following API resources are available in the project context:
|
[
Notification settings
](
notification_settings.md
)
|
`/projects/:id/notification_settings`
(also available for groups and standalone) |
|
[
Packages
](
packages.md
)
|
`/projects/:id/packages`
|
|
[
Pages domains
](
pages_domains.md
)
|
`/projects/:id/pages`
(also available standalone) |
|
[
Pipelines
](
pipelines.md
)
|
`/projects/:id/pipelines`
|
|
[
Pipeline schedules
](
pipeline_schedules.md
)
|
`/projects/:id/pipeline_schedules`
|
|
[
Pipeline triggers
](
pipeline_triggers.md
)
|
`/projects/:id/triggers`
|
|
[
P
rojects
](
projects.md
)
including setting Webhooks |
`/projects`
,
`/projects/:id/hooks`
(also available for users)
|
|
[
P
ipelines
](
pipelines.md
)
|
`/projects/:id/pipelines`
|
|
[
Project badges
](
project_badges.md
)
|
`/projects/:id/badges`
|
|
[
Project clusters
](
project_clusters.md
)
|
`/projects/:id/clusters`
|
|
[
Project-level variables
](
project_level_variables.md
)
|
`/projects/:id/variables`
|
|
[
Project import/export
](
project_import_export.md
)
|
`/projects/:id/export`
,
`/projects/import`
,
`/projects/:id/import`
|
|
[
Project milestones
](
milestones.md
)
|
`/projects/:id/milestones`
|
|
[
Project snippets
](
project_snippets.md
)
|
`/projects/:id/snippets`
|
|
[
Project templates
](
project_templates.md
)
|
`/projects/:id/templates`
|
|
[
Project vulnerabilities
](
project_vulnerabilities.md
)
**(ULTIMATE)**
|
`/projects/:id/templates`
|
|
[
Protected environments
](
protected_environments.md
)
|
`/projects/:id/protected_environments`
|
|
[
Project wikis
](
wikis.md
)
|
`/projects/:id/wikis`
|
|
[
Project-level variables
](
project_level_variables.md
)
|
`/projects/:id/variables`
|
|
[
Projects
](
projects.md
)
including setting Webhooks |
`/projects`
,
`/projects/:id/hooks`
(also available for users) |
|
[
Protected branches
](
protected_branches.md
)
|
`/projects/:id/protected_branches`
|
|
[
Protected environments
](
protected_environments.md
)
|
`/projects/:id/protected_environments`
|
|
[
Protected tags
](
protected_tags.md
)
|
`/projects/:id/protected_tags`
|
|
[
Releases
](
releases/index.md
)
|
`/projects/:id/releases`
|
|
[
Release links
](
releases/links.md
)
|
`/projects/:id/releases/.../assets/links`
|
|
[
Releases
](
releases/index.md
)
|
`/projects/:id/releases`
|
|
[
Remote mirrors
](
remote_mirrors.md
)
|
`/projects/:id/remote_mirrors`
|
|
[
Repositories
](
repositories.md
)
|
`/projects/:id/repository`
|
|
[
Repository files
](
repository_files.md
)
|
`/projects/:id/repository/files`
|
...
...
@@ -90,14 +91,13 @@ The following API resources are available in the project context:
|
[
Vulnerabilities
](
vulnerabilities.md
)
**(ULTIMATE)**
|
`/vulnerabilities/:id`
|
|
[
Vulnerability exports
](
vulnerability_exports.md
)
**(ULTIMATE)**
|
`/projects/:id/vulnerability_exports`
|
|
[
Vulnerability findings
](
vulnerability_findings.md
)
**(ULTIMATE)**
|
`/projects/:id/vulnerability_findings`
|
|
[
Project wikis
](
wikis.md
)
|
`/projects/:id/wikis`
|
## Group resources
The following API resources are available in the group context:
| Resource | Available endpoints |
|:-----------------------------------------------------------------|:--------------------
-------------------------------------------------------------
|
|:-----------------------------------------------------------------|:--------------------|
|
[
Access requests
](
access_requests.md
)
|
`/groups/:id/access_requests/`
(also available for projects) |
|
[
Custom attributes
](
custom_attributes.md
)
|
`/groups/:id/custom_attributes`
(also available for projects and users) |
|
[
Debian distributions
](
packages/debian_group_distributions.md
)
|
`/groups/:id/-/packages/debian`
(also available for projects) |
...
...
@@ -112,6 +112,7 @@ The following API resources are available in the group context:
|
[
Group labels
](
group_labels.md
)
|
`/groups/:id/labels`
|
|
[
Group-level variables
](
group_level_variables.md
)
|
`/groups/:id/variables`
|
|
[
Group milestones
](
group_milestones.md
)
|
`/groups/:id/milestones`
|
|
[
Group wikis
](
group_wikis.md
)
**(PREMIUM)**
|
`/groups/:id/wikis`
|
|
[
Invitations
](
invitations.md
)
|
`/groups/:id/invitations`
(also available for projects) |
|
[
Issues
](
issues.md
)
|
`/groups/:id/issues`
(also available for projects and standalone) |
|
[
Issues Statistics
](
issues_statistics.md
)
|
`/groups/:id/issues_statistics`
(also available for projects and standalone) |
...
...
@@ -121,16 +122,13 @@ The following API resources are available in the group context:
|
[
Notification settings
](
notification_settings.md
)
|
`/groups/:id/notification_settings`
(also available for projects and standalone) |
|
[
Resource label events
](
resource_label_events.md
)
|
`/groups/:id/epics/.../resource_label_events`
(also available for projects) |
|
[
Search
](
search.md
)
|
`/groups/:id/search`
(also available for projects and standalone) |
|
[
Group wikis
](
group_wikis.md
)
**(PREMIUM)**
|
`/groups/:id/wikis`
|
## Standalone resources
The following API resources are available outside of project and group contexts (including
`/users`
):
| Resource | Available endpoints |
|:---------------------------------------------------|:------------------------------------------------------------------------|
|
[
Instance-level CI/CD variables
](
instance_level_ci_variables.md
)
**(FREE SELF)**
|
`/admin/ci/variables`
|
|
[
Sidekiq queues administration
](
admin_sidekiq_queues.md
)
**(FREE SELF)**
|
`/admin/sidekiq/queues/:queue_name`
|
|:----------------------------------------------------------------------------------------|:--------------------|
|
[
Appearance
](
appearance.md
)
**(FREE SELF)**
|
`/application/appearance`
|
|
[
Applications
](
applications.md
)
|
`/applications`
|
|
[
Audit Events
](
audit_events.md
)
**(PREMIUM SELF)**
|
`/audit_events`
|
...
...
@@ -142,12 +140,13 @@ The following API resources are available outside of project and group contexts
|
[
Events
](
events.md
)
|
`/events`
,
`/users/:id/events`
(also available for projects) |
|
[
Feature flags
](
features.md
)
|
`/features`
|
|
[
Geo Nodes
](
geo_nodes.md
)
**(PREMIUM SELF)**
|
`/geo_nodes`
|
|
[
Group Activity Analytics
](
group_activity_analytics.md
)
|
`/analytics/group_activity/{issues_count | merge_requests_count | new_members_count }`
|
|
[
Group Activity Analytics
](
group_activity_analytics.md
)
|
`/analytics/group_activity/{issues_count}`
|
|
[
Group repository storage moves
](
group_repository_storage_moves.md
)
**(PREMIUM SELF)**
|
`/group_repository_storage_moves`
|
|
[
Import repository from GitHub
](
import.md
)
|
`/import/github`
|
|
[
Instance clusters
](
instance_clusters.md
)
**(FREE SELF)**
|
`/admin/clusters`
|
|
[
I
ssues
](
issues.md
)
|
`/issues`
(also available for groups and projects)
|
|
[
I
nstance-level CI/CD variables
](
instance_level_ci_variables.md
)
**(FREE SELF)**
|
`/admin/ci/variables`
|
|
[
Issues Statistics
](
issues_statistics.md
)
|
`/issues_statistics`
(also available for groups and projects) |
|
[
Issues
](
issues.md
)
|
`/issues`
(also available for groups and projects) |
|
[
Jobs
](
jobs.md
)
|
`/job`
|
|
[
Keys
](
keys.md
)
|
`/keys`
|
|
[
License
](
license.md
)
**(FREE SELF)**
|
`/license`
|
...
...
@@ -157,21 +156,22 @@ The following API resources are available outside of project and group contexts
|
[
Namespaces
](
namespaces.md
)
|
`/namespaces`
|
|
[
Notification settings
](
notification_settings.md
)
|
`/notification_settings`
(also available for groups and projects) |
|
[
Pages domains
](
pages_domains.md
)
|
`/pages/domains`
(also available for projects) |
|
[
Plan limits
](
plan_limits.md
)
|
`/application/plan_limits`
|
|
[
Personal access tokens
](
personal_access_tokens.md
)
|
`/personal_access_tokens`
|
|
[
P
rojects
](
projects.md
)
|
`/users/:id/projects`
(also available for projects)
|
|
[
P
lan limits
](
plan_limits.md
)
|
`/application/plan_limits`
|
|
[
Project repository storage moves
](
project_repository_storage_moves.md
)
**(FREE SELF)**
|
`/project_repository_storage_moves`
|
|
[
Projects
](
projects.md
)
|
`/users/:id/projects`
(also available for projects) |
|
[
Runners
](
runners.md
)
|
`/runners`
(also available for projects) |
|
[
Search
](
search.md
)
|
`/search`
(also available for groups and projects) |
|
[
Service Data
](
usage_data.md
)
|
`/usage_data`
(For GitLab instance
[
Administrator
](
../user/permissions.md
)
users only) |
|
[
Settings
](
settings.md
)
**(FREE SELF)**
|
`/application/settings`
|
|
[
Sidekiq metrics
](
sidekiq_metrics.md
)
**(FREE SELF)**
|
`/sidekiq`
|
|
[
Sidekiq queues administration
](
admin_sidekiq_queues.md
)
**(FREE SELF)**
|
`/admin/sidekiq/queues/:queue_name`
|
|
[
Snippet repository storage moves
](
snippet_repository_storage_moves.md
)
**(FREE SELF)**
|
`/snippet_repository_storage_moves`
|
|
[
Statistics
](
statistics.md
)
|
`/application/statistics`
|
|
[
Sidekiq metrics
](
sidekiq_metrics.md
)
**(FREE SELF)**
|
`/sidekiq`
|
|
[
Suggestions
](
suggestions.md
)
|
`/suggestions`
|
|
[
System hooks
](
system_hooks.md
)
|
`/hooks`
|
|
[
To-dos
](
todos.md
)
|
`/todos`
|
|
[
Topics
](
topics.md
)
|
`/topics`
|
|
[
Service Data
](
usage_data.md
)
|
`/usage_data`
(For GitLab instance
[
Administrator
](
../user/permissions.md
)
users only) |
|
[
Users
](
users.md
)
|
`/users`
|
|
[
Validate `.gitlab-ci.yml` file
](
lint.md
)
|
`/lint`
|
|
[
Version
](
version.md
)
|
`/version`
|
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment
