View a Tugboat Service

Retrieves the details of one or more Tugboat Services.

Arguments

  • service - Optional
    The service to list.If not specified, all services that the user has permission to view are returned.

  • preview - Optional
    Only list services in the provided preview. If service is also specified, this argument is ignored.

  • repo - Optional
    Only list services in the provided repository. If service or preview are also specified, this argument is ignored.

  • project - Optional
    Only list services in the provided project. If service, preview, or repo are also specified, this argument is ignored.

Example

socket.emit('tugboat', 'services', 'list', args, callback);

Output

single

{
    "_id": "58cf4e012057230001ae530b",
    "updatedAt": "2017-03-20T18:40:00.045Z",
    "createdAt": "2017-03-20T03:35:29.758Z",
    "name": "apache",
    "preview": "58cf4e012057230001ae530a",
    "size": 418248599,
    "state": "ready",
    "id": "58cf4e012057230001ae530b"
}

array

[
    {
        "_id": "58cf4e012057230001ae530b",
        "updatedAt": "2017-03-20T18:40:00.045Z",
        "createdAt": "2017-03-20T03:35:29.758Z",
        "name": "apache",
        "preview": "58cf4e012057230001ae530a",
        "size": 418248599,
        "state": "ready",
        "id": "58cf4e012057230001ae530b"
    }
]

Errors

  • 1016: No Services Found
    Returned if the requested services do not exist, or the requestor does not have permission to view them.

results matching ""

    No results matching ""