Vridlo/api/vridlo.assemblers: Difference between revisions

From ALT Linux Wiki
(Created page with "==== vridlo.assembler.show ==== 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. ===== P...")
 
Line 14: Line 14:
===== Arguments =====
===== Arguments =====


* per_page (Optional)
This method requires NO arguments.
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 =====
===== Example Response =====

Revision as of 12:34, 22 August 2019

vridlo.assembler.show

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/<slug>

Authentication

This method requires NO authentication.

Arguments

This method requires NO arguments.

Example Response
Good response:

[
 {
  "slug": "ca"
  "name": "Core Assembler"
  "host": "assembler.altlinux.org"
  "source_path_count": 3
  "export_path_base": "/export/path/to"
 }
]

Error response:

[
 {
  "slug": "ca",
  "error_code": 3
 }
]
Error Codes
  • 423.3 (SSL is required)
SSL is required to access the Vridlo API.
  • 404 (Not Found)
The record with provided slug is not found.
  • 500 (Internal Server Error)
The Internal Server Error has occurred.