Lattice API Docs (1.0)

Download OpenAPI specification:Download

This document describes the lattice API.

Authentication

ApiKeyAuth

Security scheme type:	API Key
header parameter name:	apiKey

systems

List systems

Responses

200

get /systems

null//localhost:8876/v1/systems

Response samples

application/json

Copy

Expand all Collapse all

[

{
- "definitionUrl": "git://github.com/foo/foo.git",
- "id": { },
- "services": { },
- "state": { }
}

]

Create system

Create a new system

Request Body schema: application/json

definitionUrl	string TBD
id	object (v1.SystemID)

Responses

200

400

Bad Request

post /systems

null//localhost:8876/v1/systems

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"definitionUrl": "git://github.com/foo/foo.git",
"id": { }

}

Response samples

application/json

Copy

Expand all Collapse all

{

"definitionUrl": "git://github.com/foo/foo.git",
"id": { },
"services": { },
"state": { }

}

Get system

get system

path Parameters

system

required

string

System ID

Responses

200

404

Not Found

get /systems/{system}

null//localhost:8876/v1/systems/{system}

Response samples

application/json

Copy

Expand all Collapse all

{

"definitionUrl": "git://github.com/foo/foo.git",
"id": { },
"services": { },
"state": { }

}

Delete system

path Parameters

system

required

string

System ID

Responses

200

404

Not Found

delete /systems/{system}

null//localhost:8876/v1/systems/{system}

Response samples

application/json

Copy

Expand all Collapse all

{ }

builds

Lists builds

list builds

path Parameters

system

required

string

System ID

Responses

200

get /systems/{system}/builds

null//localhost:8876/v1/systems/{system}/builds

Response samples

application/json

Copy

Expand all Collapse all

[

{
- "completionTimestamp": "string",
- "id": { },
- "services": { },
- "startTimestamp": "string",
- "state": { },
- "version": { }
}

]

Build system

build system

path Parameters

system

required

string

System ID

Request Body schema: application/json

version

object (v1.SystemVersion)

Responses

200

400

Bad Request

post /systems/{system}/builds

null//localhost:8876/v1/systems/{system}/builds

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"version": { }

}

Response samples

application/json

Copy

Expand all Collapse all

{

"completionTimestamp": "string",
"id": { },
"services": { },
"startTimestamp": "string",
"state": { },
"version": { }

}

Get build

get build

path Parameters

system required	string System ID
id required	string Build ID

Responses

200

404

Not Found

get /systems/{system}/builds/{id}

null//localhost:8876/v1/systems/{system}/builds/{id}

Response samples

application/json

Copy

Expand all Collapse all

{

"completionTimestamp": "string",
"id": { },
"services": { },
"startTimestamp": "string",
"state": { },
"version": { }

}

Get build logs

get logs

path Parameters

system required	string System ID
id required	string Build ID

query Parameters

path required	string Node Path
sidecar	string Sidecar
follow	string Follow
previous	boolean Previous
timestamps	boolean Timestamps
tail	integer tail
since	string Since
sinceTime	string Since Time

Responses

200

log stream

404

Not Found

get /systems/{system}/builds/{id}/logs

null//localhost:8876/v1/systems/{system}/builds/{id}/logs

Response samples

application/json

Copy

Expand all Collapse all

"string"

deploys

Lists deploys

list deploys

path Parameters

system

required

string

System ID

Responses

200

get /systems/{system}/deploys

null//localhost:8876/v1/systems/{system}/deploys

Response samples

application/json

Copy

Expand all Collapse all

[

{
- "buildId": { },
- "id": { },
- "state": { }
}

]

Deploy system

build system

path Parameters

system

required

string

System ID

Request Body schema: application/json

buildId	object (v1.BuildID)
version	object (v1.SystemVersion)

Responses

200

400

Bad Request

post /systems/{system}/deploys

null//localhost:8876/v1/systems/{system}/deploys

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"buildId": { },
"version": { }

}

Response samples

application/json

Copy

Expand all Collapse all

{

"buildId": { },
"id": { },
"state": { }

}

Get deploy

get deploy

path Parameters

system required	string System ID
id required	string Deploy ID

Responses

200

404

Not Found

get /systems/{system}/deploys/{id}

null//localhost:8876/v1/systems/{system}/deploys/{id}

Response samples

application/json

Copy

Expand all Collapse all

{

"buildId": { },
"id": { },
"state": { }

}

jobs

Lists jobs

list jobs

path Parameters

system

required

string

System ID

Responses

200

get /systems/{system}/jobs

null//localhost:8876/v1/systems/{system}/jobs

Response samples

application/json

Copy

Expand all Collapse all

[

{
- "completionTimestamp": "string",
- "id": { },
- "path": "string",
- "startTimestamp": "string",
- "state": { }
}

]

Get job

get job

path Parameters

system required	string System ID
id required	string Job ID

Responses

200

404

Not Found

get /systems/{system}/jobs/{id}

null//localhost:8876/v1/systems/{system}/jobs/{id}

Response samples

application/json

Copy

Expand all Collapse all

{

"completionTimestamp": "string",
"id": { },
"path": "string",
"startTimestamp": "string",
"state": { }

}

Get job logs

get job logs

path Parameters

system required	string System ID
id required	string Job ID

query Parameters

sidecar	string Sidecar
follow	string Follow
previous	boolean Previous
timestamps	boolean Timestamps
tail	integer tail
since	string Since
sinceTime	string Since Time

Responses

200

log stream

404

Not Found

get /systems/{system}/jobs/{id}/logs

null//localhost:8876/v1/systems/{system}/jobs/{id}/logs

Response samples

application/json

Copy

Expand all Collapse all

"string"

node-pools

Lists node pools

list node pools

path Parameters

system

required

string

System ID

Responses

200

get /systems/{system}/node-pools

null//localhost:8876/v1/systems/{system}/node-pools

Response samples

application/json

Copy

Expand all Collapse all

[

{
- "failure_info":
  {
  - "message": "string",
  - "time": "string"
  },
- "id": "string",
- "instanceType": "string",
- "numInstances": 0,
- "path": "string",
- "state": { }
}

]

Get node pool

get node pool

path Parameters

system required	string System ID
id required	string NodePool ID

Responses

200

404

Not Found

get /systems/{system}/node-pools/{id}

null//localhost:8876/v1/systems/{system}/node-pools/{id}

Response samples

application/json

Copy

Expand all Collapse all

{

"failure_info":
{
- "message": "string",
- "time": "string"
},
"id": "string",
"instanceType": "string",
"numInstances": 0,
"path": "string",
"state": { }

}

secrets

Lists secrets

list secrets

path Parameters

system

required

string

System ID

Responses

200

get /systems/{system}/secrets

null//localhost:8876/v1/systems/{system}/secrets

Response samples

application/json

Copy

Expand all Collapse all

[

{
- "name": "string",
- "path": "string",
- "value": "string"
}

]

set secret

path Parameters

system

required

string

System ID

Request Body schema: application/json

value

string

TBD

Responses

200

400

Bad Request

post /systems/{system}/secrets

null//localhost:8876/v1/systems/{system}/secrets

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"value": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"name": "string",
"path": "string",
"value": "string"

}

Get secret

get secret

path Parameters

system required	string System ID
secret required	string Secret Path

Responses

200

404

Not Found

get /systems/{system}/secrets/{secret}

null//localhost:8876/v1/systems/{system}/secrets/{secret}

Response samples

application/json

Copy

Expand all Collapse all

{

"name": "string",
"path": "string",
"value": "string"

}

Delete system

get system

path Parameters

system required	string System ID
secret required	string Secret Path

Responses

200

404

Not Found

delete /systems/{system}/secrets/{secret}

null//localhost:8876/v1/systems/{system}/secrets/{secret}

Response samples

application/json

Copy

Expand all Collapse all

{ }

services

Lists services

list services

path Parameters

system

required

string

System ID

Responses

200

get /systems/{system}/services

null//localhost:8876/v1/systems/{system}/services

Response samples

application/json

Copy

Expand all Collapse all

[

{
- "availableInstances": 0,
- "failureInfo":
  {
  - "message": "string",
  - "time": "string"
  },
- "id": { },
- "instances":
  [
  - "string"
  ],
- "message": "string",
- "path": "string",
- "ports": { },
- "staleInstances": 0,
- "state": { },
- "terminatingInstances": 0,
- "updatedInstances": 0
}

]

Get service

get service

path Parameters

system required	string System ID
id required	string Service ID

Responses

200

404

Not Found

get /systems/{system}/services/{id}

null//localhost:8876/v1/systems/{system}/services/{id}

Response samples

application/json

Copy

Expand all Collapse all

{

"availableInstances": 0,
"failureInfo":
{
- "message": "string",
- "time": "string"
},
"id": { },
"instances":
[
- "string"
],
"message": "string",
"path": "string",
"ports": { },
"staleInstances": 0,
"state": { },
"terminatingInstances": 0,
"updatedInstances": 0

}

Get service logs

get service logs

path Parameters

system required	string System ID
id required	string Service ID

query Parameters

instance required	string Instance
sidecar	string Sidecar
follow	string Follow
previous	boolean Previous
timestamps	boolean Timestamps
tail	integer tail
since	string Since
sinceTime	string Since Time

Responses

200

log stream

404

Not Found

get /systems/{system}/services/{id}/logs

null//localhost:8876/v1/systems/{system}/services/{id}/logs

Response samples

application/json

Copy

Expand all Collapse all

"string"

teardowns

Lists teardowns

list teardowns

path Parameters

system

required

string

System ID

Responses

200

get /systems/{system}/teardowns

null//localhost:8876/v1/systems/{system}/teardowns

Response samples

application/json

Copy

Expand all Collapse all

[

{
- "id": { },
- "state": { }
}

]

Teardown system

teardown system

path Parameters

system

required

string

System ID

Responses

200

400

Bad Request

404

Not Found

post /systems/{system}/teardowns

null//localhost:8876/v1/systems/{system}/teardowns

Response samples

application/json

Copy

Expand all Collapse all

{

"id": { },
"state": { }

}

Get teardown

get teardown

path Parameters

system required	string System ID
id required	string Teardown ID

Responses

200

404

Not Found

get /systems/{system}/teardowns/{id}

null//localhost:8876/v1/systems/{system}/teardowns/{id}

Response samples

application/json

Copy

Expand all Collapse all

{

"id": { },
"state": { }

}

versions

Lists system versions

list teardowns

path Parameters

system

required

string

System ID

Responses

200

get /systems/{system}/versions

null//localhost:8876/v1/systems/{system}/versions

Response samples

application/json

Copy

Expand all Collapse all

[

]