Skip to content

Services

This API endpoint offers developers a seamless way to access valuable information about services within the LinearB platform. By utilizing this endpoint, you can effortlessly retrieve the details of services and the specific repositories and paths configured for each service

Get services

Get a list of services that have been configured in the LinearB platform

HTTP request

GET  https://public-api.linearb.io/api/v1/services

Query parameter

Parameter name Value Description
repository_id integer Repository ID to filter by.
Return only services where this repository is presented

Responses

200 - Successful Response

{
 "total": 0,
 "items": [
     {
       "id": 0,
       "name": "string",
       "paths": [
           {
             "id": 0,
             "name": "string",
             "paths": [
                 "string"
                 ]
            }
        ]
    }
  ]
}

400 - Bad Request

401 - Unauthorized

405 - Method Not Allowed

422 - Validation Error

500 - Internal Server Error

504 - Endpoint request timed out

Get service

Get a single service by its ID.

HTTP request

GET  https://public-api.linearb.io/api/v1/services/{service_id}

Query parameter

Parameter name Value Description
service_id
(required)
integer The service ID

Responses

200 - Successful Response

{
  "id": 0,
  "name": "string",
  "paths": [
      {
      "id": 0,
      "name": "string",
      "paths": [
        "string"
      ]
    }
  ]
}

400 - Bad Request

401 - Unauthorized

405 - Method Not Allowed

422 - Validation Error

500 - Internal Server Error

504 - Endpoint request timed out