Vridlo/api/vridlo.assembler.index: Difference between revisions
Line 36: | Line 36: | ||
] | ] | ||
===== | ===== Return Codes ===== | ||
* ''' | * '''200''' (''OK'') | ||
The resource list is accessible. Returned data responds to the current state of the resource list, and reading the list is finished. | |||
* '''206''' (''Partial Content'') | |||
The resource list is accessible. Returned data responds to the current state of the resource list, and reading the list is NOT finished yet. | |||
* '''416''' (''Range Not Satisfiable'') | |||
The resource list is accessible. But data can't be returned since range provided don't match the list boundaries. | |||
* '''422.3''' (''SSL is required'') | |||
SSL is required to access the Vridlo API. | SSL is required to access the Vridlo API. | ||
* '''500''' (''Service currently unavailable'') | * '''500''' (''Service currently unavailable'') | ||
The requested service is temporarily unavailable. | The requested service is temporarily unavailable. |
Revision as of 16:08, 22 August 2019
vridlo.assembler.index
Returns a list of assemblers, which are presented in the system. Do not poll this method more than once an hour. Added into API v1.0.
Path
GET: /v1/assemblers
Authentication
This method requires NO authentication.
Arguments
- per_page (Optional)
Number of items to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50.
- page (Optional)
The page of results to return. If this argument is omitted, it defaults to 1.
Example Response
[ { "name": "Core Assembler" "host": "assembler.altlinux.org" "source_path_count": 3 "export_path_base": "/export/path/to" }, { "name": "Secondary Assembler" "host": "secondary.altlinux.org" "source_path_count": 1 "export_path_base": "/export/path/to/sec/" } ]
Return Codes
- 200 (OK)
The resource list is accessible. Returned data responds to the current state of the resource list, and reading the list is finished.
- 206 (Partial Content)
The resource list is accessible. Returned data responds to the current state of the resource list, and reading the list is NOT finished yet.
- 416 (Range Not Satisfiable)
The resource list is accessible. But data can't be returned since range provided don't match the list boundaries.
- 422.3 (SSL is required)
SSL is required to access the Vridlo API.
- 500 (Service currently unavailable)
The requested service is temporarily unavailable.