API Reference

Katapult Core API

Resources & Endpoints

Get operating system

Return details for a specific operating system.

GET
https://api.katapult.io/core/v1/operating_systems/{operating_system}

If successful, this endpoint will return a 200 OK status.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

operating_system Required

The operating system to return

 Operating System Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

operating_system_not_found

No operating system was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    operating_system: OperatingSystem {
        id: String
        name: String
        badge: Attachment? {
            url: String
            file_name: String
            file_type: String
            file_size: Integer
            digest: String
            token: String
        }
    }
}