Search admin API
- Tier: Premium, Ultimate
- Offering: GitLab Self-Managed
The search admin API returns information about advanced search migrations.
You must have administrator access to use this API.
List all advanced search migrations
Get a list of all advanced search migrations for the GitLab instance.
GET /admin/search/migrations
Example request:
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/admin/search/migrations"
Example response:
[
{
"version": 20230427555555,
"name": "BackfillHiddenOnMergeRequests",
"started_at": "2023-05-12T01:35:05.469+00:00",
"completed_at": "2023-05-12T01:36:06.432+00:00",
"completed": true,
"obsolete": false,
"migration_state": {}
},
{
"version": 20230428500000,
"name": "AddSuffixProjectInWikiRid",
"started_at": "2023-05-04T18:59:43.542+00:00",
"completed_at": "2023-05-04T18:59:43.542+00:00",
"completed": false,
"obsolete": false,
"migration_state": {
"pause_indexing": true,
"slice": 1,
"task_id": null,
"max_slices": 5,
"retry_attempt": 0
}
},
{
"version": 20230503064300,
"name": "BackfillProjectPermissionsInBlobsUsingPermutations",
"started_at": "2023-05-03T16:04:44.074+00:00",
"completed_at": "2023-05-03T16:04:44.074+00:00",
"completed": true,
"obsolete": false,
"migration_state": {
"permutation_idx": 8,
"documents_remaining": 5,
"task_id": "I2_LXc-xQlOeu-KmjYpM8g:172820",
"documents_remaining_for_permutation": 0
}
}
]
Get an advanced search migration
Get a single advanced search migration by providing the migration version or name.
GET /admin/search/mirations/:version_or_name
Parameters:
Attribute | Type | Required | Description |
---|---|---|---|
version_or_name | integer/string | Yes | The version or name of the migration. |
Example request:
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/admin/search/mirations/20230503064300"
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/admin/search/mirations/BackfillProjectPermissionsInBlobsUsingPermutations"
If successful, returns 200
and the following
response attributes:
Attribute | Type | Description |
---|---|---|
version | integer | Version of the migration. |
name | string | Name of the migration. |
started_at | datetime | Start date for the migration. |
completed_at | datetime | Completion date for the migration. |
completed | boolean | If true , the migration is completed. |
obsolete | boolean | If true , the migration has been marked as obsolete. |
migration_state | object | Stored migration state. |
Example response:
{
"version": 20230503064300,
"name": "BackfillProjectPermissionsInBlobsUsingPermutations",
"started_at": "2023-05-03T16:04:44.074+00:00",
"completed_at": "2023-05-03T16:04:44.074+00:00",
"completed": true,
"obsolete": false,
"migration_state": {
"permutation_idx": 8,
"documents_remaining": 5,
"task_id": "I2_LXc-xQlOeu-KmjYpM8g:172820",
"documents_remaining_for_permutation": 0
}
}
Docs
Edit this page to fix an error or add an improvement in a merge request.
Create an issue to suggest an improvement to this page.
Product
Create an issue if there's something you don't like about this feature.
Propose functionality by submitting a feature request.
Feature availability and product trials
View pricing to see all GitLab tiers and features, or to upgrade.
Try GitLab for free with access to all features for 30 days.
Get help
If you didn't find what you were looking for, search the docs.
If you want help with something specific and could use community support, post on the GitLab forum.
For problems setting up or using this feature (depending on your GitLab subscription).
Request support