kusk-gateway-api (1.0.0)

Download OpenAPI specification:Download

This is the Kusk Gateway Management API

apis

Get the list of the APIs

Get a list of APIs

Returns the list of APIs available in the cluster

query Parameters

fleetname	string optional filter on fleet
fleetnamespace	string optional filter on fleet
namespace	string optional filter on namespace

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"namespace": "string",
"fleet": {"name": "string",
"namespace": "string"
},
"service": {"name": "string",
"namespace": "string"
},
"version": "string",
"crunch42url": "string"
}
]

Deploy new API

Deploys a new API to the cluster

Request Body schema: application/json

API content that needs to be deployed

name	string
namespace	string
envoyFleetName	string
envoyFleetNamespace	string
openapi	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"namespace": "string",
"envoyFleetName": "string",
"envoyFleetNamespace": "string",
"openapi": "string"
}

Response samples

400

Content type

application/json

"string"

Get an API instance by namespace and name

path Parameters

namespace required	string Default: "default"
name required	string

Responses

Response samples

200

Content type

application/json

{"name": "string",
"namespace": "string",
"fleet": {"name": "string",
"namespace": "string"
},
"service": {"name": "string",
"namespace": "string"
},
"version": "string",
"crunch42url": "string"
}

Update an existing API

Updates an existing API in the cluster

path Parameters

namespace required	string Default: "default"
name required	string

Request Body schema: application/json

API content that needs to be updated

name	string
namespace	string
envoyFleetName	string
envoyFleetNamespace	string
openapi	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"namespace": "string",
"envoyFleetName": "string",
"envoyFleetNamespace": "string",
"openapi": "string"
}

Response samples

400

Content type

application/json

"string"

Delete an API instance by namespace and name

path Parameters

namespace required	string Default: "default"
name required	string

Responses

Get API CRD from cluster

path Parameters

namespace required	string Default: "default"
name required	string

Responses

Response samples

200

Content type

application/json

{ }

Get API definition ( Post-Processed version )

path Parameters

namespace required	string Default: "default"
name required	string

Responses

Response samples

200

Content type

application/json

{ }

services

Get the list of all services

Get a list of services handled by kusk-gateway

Returns the list of services available in the cluster that are related to kusk-gateway

query Parameters

namespace

string

optional filter on namespace

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"status": "available",
"namespace": "string",
"serviceType": "ClusterIP",
"ports": [{"name": "string",
"nodePort": 0,
"port": 0,
"protocol": "string",
"targetPort": "string"
}
]
}
]

Get details for a single service

Returns an object containing info about the service corresponding to the namespace and name

path Parameters

namespace required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"name": "string",
"status": "available",
"namespace": "string",
"serviceType": "ClusterIP",
"ports": [{"name": "string",
"nodePort": 0,
"port": 0,
"protocol": "string",
"targetPort": "string"
}
]
}

fleets

Get the list of all envoy fleets

Get a list of envoy fleets

Returns a list of envoy fleets that are available in the cluster

query Parameters

namespace

string

optional filter on namespace

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"namespace": "string",
"apis": [{"name": "string",
"namespace": "string"
}
],
"services": [{"name": "string",
"status": "available",
"namespace": "string",
"serviceType": "ClusterIP",
"ports": [{"name": "string",
"nodePort": 0,
"port": 0,
"protocol": "string",
"targetPort": "string"
}
]
}
],
"staticRoutes": [{"name": "string",
"namespace": "string"
}
]
}
]

Get details for a single envoy fleet

Returns an object containing info about the envoy fleet corresponding to the namespace and name

path Parameters

namespace required	string the namespace of the fleet
name required	string the name of the fleet

Responses

Response samples

200

Content type

application/json

{"name": "string",
"namespace": "string",
"apis": [{"name": "string",
"namespace": "string"
}
],
"services": [{"name": "string",
"status": "available",
"namespace": "string",
"serviceType": "ClusterIP",
"ports": [{"name": "string",
"nodePort": 0,
"port": 0,
"protocol": "string",
"targetPort": "string"
}
]
}
],
"staticRoutes": [{"name": "string",
"namespace": "string"
}
]
}

Delete a Fleet instance by namespace and name

path Parameters

namespace required	string Default: "default"
name required	string

Responses

Get envoy fleet CRD

path Parameters

namespace required	string Default: "default"
name required	string

Responses

Response samples

200

Content type

application/json

{ }

Get envoy fleet logs

query Parameters

namespace required	string Default: "kusk-system"
name required	string Default: "kusk-gateway-envoy-fleet"

Responses

Response samples

200

Content type

application/json

{ }

static routes

Get the list of all static routes

Get a list of static routes

Returns a list of static routes

query Parameters

namespace

string

optional filter on namespace

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"namespace": "string",
"envoyFleetName": "string",
"envoyFleetNamespace": "string"
}
]

Get details for a single static route

Returns an object containing info about the static route corresponding to the namespace and name

path Parameters

namespace required	string the namespace of the static route
name required	string the name of the static route

Responses

Response samples

200

Content type

application/json

{"name": "string",
"namespace": "string",
"envoyFleetName": "string",
"envoyFleetNamespace": "string"
}

Update a static route by namespace and name

path Parameters

namespace required	string Default: "default"
name required	string

Request Body schema: application/json

static route content

name	string
namespace	string
envoyFleetName	string
envoyFleetNamespace	string
openapi	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"namespace": "string",
"envoyFleetName": "string",
"envoyFleetNamespace": "string",
"openapi": "string"
}

Response samples

201
400

Content type

application/json

{"name": "string",
"namespace": "string",
"envoyFleetName": "string",
"envoyFleetNamespace": "string"
}

Get static route CRD

path Parameters

namespace required	string Default: "default"
name required	string

Responses

Response samples

200

Content type

application/json

{ }

create new fleet

Request Body schema: application/json

create fleet content

name required	string
status	string Enum: "available" "unavailable"
namespace required	string
serviceType required	string Enum: "ClusterIP" "LoadBalancer"
required	Array of objects (ServicePortItem)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"status": "available",
"namespace": "string",
"serviceType": "ClusterIP",
"ports": [{"name": "string",
"nodePort": 0,
"port": 0,
"protocol": "string",
"targetPort": "string"
}
]
}

Response samples

200
400

Content type

application/json

{"name": "string",
"namespace": "string",
"apis": [{"name": "string",
"namespace": "string"
}
],
"services": [{"name": "string",
"status": "available",
"namespace": "string",
"serviceType": "ClusterIP",
"ports": [{"name": "string",
"nodePort": 0,
"port": 0,
"protocol": "string",
"targetPort": "string"
}
]
}
],
"staticRoutes": [{"name": "string",
"namespace": "string"
}
]
}

create new static route

Request Body schema: application/json

static route content

name	string
namespace	string
envoyFleetName	string
envoyFleetNamespace	string
openapi	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"namespace": "string",
"envoyFleetName": "string",
"envoyFleetNamespace": "string",
"openapi": "string"
}

Response samples

200
400

Content type

application/json

{"name": "string",
"namespace": "string",
"envoyFleetName": "string",
"envoyFleetNamespace": "string"
}

static Route

Delete a StaticRoute by namespace and name

path Parameters

namespace required	string Default: "default"
name required	string

Responses

namespaces

Get a list of namespaces

Returns a list of namespaces

Responses

Response samples

200

Content type

application/json

[{"name": "string"
}
]