Menu Close
Settings Close

Language and Page Formatting Options

Appendix D. REST API Reference

D.1. EnMasse REST API

D.1.1. Overview

This is the EnMasse API specification.

D.1.1.1. Version information

Version : 1.0.0

D.1.1.2. URI scheme

Schemes : HTTPS

D.1.1.3. Tags

  • addresses : Operating on Addresses.
  • addressplans : Operating on AddressPlans.
  • addressspaceplans : Operating on AddressSpacePlans.
  • addressspaces : Operate on AddressSpaces
  • brokeredinfraconfigs : Operating on BrokeredInfraConfigs.
  • messagingusers : Operating on MessagingUsers.
  • standardinfraconfigs : Operating on StandardInfraConfigs.

D.1.1.4. External Docs

Description : Find out more about EnMasse
URL : http://enmasse.io

D.1.2. Paths

D.1.2.1. POST /apis/admin.enmasse.io/v1beta2/namespaces/{namespace}/addressspaceplans

D.1.2.1.1. Description

create an AddressSpacePlan

D.1.2.1.2. Parameters
TypeNameDescriptionSchema

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Body

body
required

 

io.enmasse.admin.v1beta2.AddressSpacePlan

D.1.2.1.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.admin.v1beta2.AddressSpacePlan

201

Created

io.enmasse.admin.v1beta2.AddressSpacePlan

401

Unauthorized

No Content

D.1.2.1.4. Consumes
  • application/json
D.1.2.1.5. Produces
  • application/json
D.1.2.1.6. Tags
  • addressspaceplan
  • admin
  • enmasse_v1beta2

D.1.2.2. GET /apis/admin.enmasse.io/v1beta2/namespaces/{namespace}/addressspaceplans

D.1.2.2.1. Description

list objects of kind AddressSpacePlan

D.1.2.2.2. Parameters
TypeNameDescriptionSchema

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything.

string

D.1.2.2.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.admin.v1beta2.AddressSpacePlanList

401

Unauthorized

No Content

D.1.2.2.4. Produces
  • application/json
D.1.2.2.5. Tags
  • addressspaceplan
  • admin
  • enmasse_v1beta2

D.1.2.3. GET /apis/admin.enmasse.io/v1beta2/namespaces/{namespace}/addressspaceplans/{name}

D.1.2.3.1. Description

read the specified AddressSpacePlan

D.1.2.3.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of AddressSpacePlan to read.

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

D.1.2.3.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.admin.v1beta2.AddressSpacePlan

401

Unauthorized

No Content

404

Not found

No Content

D.1.2.3.4. Consumes
  • application/json
D.1.2.3.5. Produces
  • application/json
D.1.2.3.6. Tags
  • addressspaceplan
  • admin
  • enmasse_v1beta2

D.1.2.4. PUT /apis/admin.enmasse.io/v1beta2/namespaces/{namespace}/addressspaceplans/{name}

D.1.2.4.1. Description

replace the specified AddressSpacePlan

D.1.2.4.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of AddressSpacePlan to replace.

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Body

body
required

 

io.enmasse.admin.v1beta2.AddressSpacePlan

D.1.2.4.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.admin.v1beta2.AddressSpacePlan

201

Created

io.enmasse.admin.v1beta2.AddressSpacePlan

401

Unauthorized

No Content

D.1.2.4.4. Produces
  • application/json
D.1.2.4.5. Tags
  • addressspaceplan
  • admin
  • enmasse_v1beta2

D.1.2.5. DELETE /apis/admin.enmasse.io/v1beta2/namespaces/{namespace}/addressspaceplans/{name}

D.1.2.5.1. Description

delete an AddressSpacePlan

D.1.2.5.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of AddressSpacePlan to delete.

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

D.1.2.5.3. Responses
HTTP CodeDescriptionSchema

200

OK

Status

401

Unauthorized

No Content

404

Not found

No Content

D.1.2.5.4. Produces
  • application/json
D.1.2.5.5. Tags
  • addressspaceplan
  • admin
  • enmasse_v1beta2

D.1.2.6. POST /apis/enmasse.io/v1beta1/namespaces/{namespace}/addresses

D.1.2.6.1. Description

create an Address

D.1.2.6.2. Parameters
TypeNameDescriptionSchema

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Body

body
required

 

io.enmasse.v1beta1.Address

D.1.2.6.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.v1beta1.Address

201

Created

io.enmasse.v1beta1.Address

401

Unauthorized

No Content

D.1.2.6.4. Consumes
  • application/json
D.1.2.6.5. Produces
  • application/json
D.1.2.6.6. Tags
  • addresses
  • enmasse_v1beta1

D.1.2.7. GET /apis/enmasse.io/v1beta1/namespaces/{namespace}/addresses

D.1.2.7.1. Description

list objects of kind Address

D.1.2.7.2. Parameters
TypeNameDescriptionSchema

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything.

string

D.1.2.7.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.v1beta1.AddressList

401

Unauthorized

No Content

D.1.2.7.4. Produces
  • application/json
D.1.2.7.5. Tags
  • addresses
  • enmasse_v1beta1

D.1.2.8. GET /apis/enmasse.io/v1beta1/namespaces/{namespace}/addresses/{name}

D.1.2.8.1. Description

read the specified Address

D.1.2.8.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of Address to read

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

D.1.2.8.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.v1beta1.Address

401

Unauthorized

No Content

404

Not found

No Content

D.1.2.8.4. Consumes
  • application/json
D.1.2.8.5. Produces
  • application/json
D.1.2.8.6. Tags
  • addresses
  • enmasse_v1beta1

D.1.2.9. PUT /apis/enmasse.io/v1beta1/namespaces/{namespace}/addresses/{name}

D.1.2.9.1. Description

replace the specified Address

D.1.2.9.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of Address to replace

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Body

body
required

 

io.enmasse.v1beta1.Address

D.1.2.9.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.v1beta1.Address

201

Created

io.enmasse.v1beta1.Address

401

Unauthorized

No Content

D.1.2.9.4. Produces
  • application/json
D.1.2.9.5. Tags
  • addresses
  • enmasse_v1beta1

D.1.2.10. DELETE /apis/enmasse.io/v1beta1/namespaces/{namespace}/addresses/{name}

D.1.2.10.1. Description

delete an Address

D.1.2.10.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of Address to delete

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

D.1.2.10.3. Responses
HTTP CodeDescriptionSchema

200

OK

Status

401

Unauthorized

No Content

404

Not found

No Content

D.1.2.10.4. Produces
  • application/json
D.1.2.10.5. Tags
  • addresses
  • enmasse_v1beta1

D.1.2.11. PATCH /apis/enmasse.io/v1beta1/namespaces/{namespace}/addresses/{name}

D.1.2.11.1. Description

patches (RFC6902) the specified Address

D.1.2.11.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of Address to replace

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Body

body
required

 

JsonPatchRequest

D.1.2.11.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.v1beta1.Address

401

Unauthorized

No Content

D.1.2.11.4. Consumes
  • application/json-patch+json
D.1.2.11.5. Produces
  • application/json
D.1.2.11.6. Tags
  • addresses
  • enmasse_v1beta1

D.1.2.12. POST /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces

D.1.2.12.1. Description

create an AddressSpace

D.1.2.12.2. Parameters
TypeNameDescriptionSchema

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Body

body
required

 

io.enmasse.v1beta1.AddressSpace

D.1.2.12.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.v1beta1.AddressSpace

201

Created

io.enmasse.v1beta1.AddressSpace

401

Unauthorized

No Content

D.1.2.12.4. Consumes
  • application/json
D.1.2.12.5. Produces
  • application/json
D.1.2.12.6. Tags
  • addressspaces
  • enmasse_v1beta1

D.1.2.13. GET /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces

D.1.2.13.1. Description

list objects of kind AddressSpace

D.1.2.13.2. Parameters
TypeNameDescriptionSchema

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything.

string

D.1.2.13.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.v1beta1.AddressSpaceList

401

Unauthorized

No Content

D.1.2.13.4. Produces
  • application/json
D.1.2.13.5. Tags
  • addressspaces
  • enmasse_v1beta1

D.1.2.14. POST /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses

D.1.2.14.1. Description

create Addresses in an AddressSpace

D.1.2.14.2. Parameters
TypeNameDescriptionSchema

Path

addressSpace
required

Name of AddressSpace

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Body

body
required

AddressList object

io.enmasse.v1beta1.AddressList

D.1.2.14.3. Responses
HTTP CodeDescriptionSchema

200

OK

Status

401

Unauthorized

No Content

404

Not found

No Content

D.1.2.14.4. Consumes
  • application/json
D.1.2.14.5. Produces
  • application/json
D.1.2.14.6. Tags
  • addressspace_addresses
  • enmasse_v1beta1

D.1.2.15. GET /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses

D.1.2.15.1. Description

list objects of kind Address in AddressSpace

D.1.2.15.2. Parameters
TypeNameDescriptionSchema

Path

addressSpace
required

Name of AddressSpace

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

D.1.2.15.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.v1beta1.AddressList

401

Unauthorized

No Content

404

Not found

No Content

D.1.2.15.4. Produces
  • application/json
D.1.2.15.5. Tags
  • addressspace_addresses
  • enmasse_v1beta1

D.1.2.16. GET /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses/{address}

D.1.2.16.1. Description

read the specified Address in AddressSpace

D.1.2.16.2. Parameters
TypeNameDescriptionSchema

Path

address
required

Name of Address

string

Path

addressSpace
required

Name of AddressSpace

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

D.1.2.16.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.v1beta1.Address

401

Unauthorized

No Content

404

Not found

No Content

D.1.2.16.4. Produces
  • application/json
D.1.2.16.5. Tags
  • addressspace_addresses
  • enmasse_v1beta1

D.1.2.17. PUT /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses/{address}

D.1.2.17.1. Description

replace Address in an AddressSpace

D.1.2.17.2. Parameters
TypeNameDescriptionSchema

Path

address
required

Name of address

string

Path

addressSpace
required

Name of AddressSpace

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Body

body
required

Address object

io.enmasse.v1beta1.Address

D.1.2.17.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.v1beta1.Address

201

Created

io.enmasse.v1beta1.Address

401

Unauthorized

No Content

404

Not found

No Content

D.1.2.17.4. Consumes
  • application/json
D.1.2.17.5. Produces
  • application/json
D.1.2.17.6. Tags
  • addressspace_addresses
  • enmasse_v1beta1

D.1.2.18. DELETE /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses/{address}

D.1.2.18.1. Description

delete an Address in AddressSpace

D.1.2.18.2. Parameters
TypeNameDescriptionSchema

Path

address
required

Name of Address

string

Path

addressSpace
required

Name of AddressSpace

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

D.1.2.18.3. Responses
HTTP CodeDescriptionSchema

200

OK

Status

401

Unauthorized

No Content

404

Not found

No Content

D.1.2.18.4. Produces
  • application/json
D.1.2.18.5. Tags
  • addressspace_addresses
  • enmasse_v1beta1

D.1.2.19. GET /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{name}

D.1.2.19.1. Description

read the specified AddressSpace

D.1.2.19.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of AddressSpace to read

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

D.1.2.19.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.v1beta1.AddressSpace

401

Unauthorized

No Content

404

Not found

No Content

D.1.2.19.4. Consumes
  • application/json
D.1.2.19.5. Produces
  • application/json
D.1.2.19.6. Tags
  • addressspaces
  • enmasse_v1beta1

D.1.2.20. PUT /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{name}

D.1.2.20.1. Description

replace the specified AddressSpace

D.1.2.20.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of AddressSpace to replace

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Body

body
required

 

io.enmasse.v1beta1.AddressSpace

D.1.2.20.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.v1beta1.AddressSpace

201

Created

io.enmasse.v1beta1.AddressSpace

401

Unauthorized

No Content

D.1.2.20.4. Produces
  • application/json
D.1.2.20.5. Tags
  • addressspaces
  • enmasse_v1beta1

D.1.2.21. DELETE /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{name}

D.1.2.21.1. Description

delete an AddressSpace

D.1.2.21.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of AddressSpace to delete

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

D.1.2.21.3. Responses
HTTP CodeDescriptionSchema

200

OK

Status

401

Unauthorized

No Content

404

Not found

No Content

D.1.2.21.4. Produces
  • application/json
D.1.2.21.5. Tags
  • addressspaces
  • enmasse_v1beta1

D.1.2.22. PATCH /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{name}

D.1.2.22.1. Description

patches (RFC6902) the specified AddressSpace

D.1.2.22.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of AddressSpace to replace

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Body

body
required

 

JsonPatchRequest

D.1.2.22.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.v1beta1.AddressSpace

401

Unauthorized

No Content

D.1.2.22.4. Consumes
  • application/json-patch+json
D.1.2.22.5. Produces
  • application/json
D.1.2.22.6. Tags
  • addressspaces
  • enmasse_v1beta1

D.1.2.23. POST /apis/user.enmasse.io/v1beta1/namespaces/{namespace}/messagingusers

D.1.2.23.1. Description

create a MessagingUser

D.1.2.23.2. Parameters
TypeNameDescriptionSchema

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Body

body
required

 

io.enmasse.user.v1beta1.MessagingUser

D.1.2.23.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.user.v1beta1.MessagingUser

201

Created

io.enmasse.user.v1beta1.MessagingUser

401

Unauthorized

No Content

D.1.2.23.4. Consumes
  • application/json
D.1.2.23.5. Produces
  • application/json
D.1.2.23.6. Tags
  • auth
  • enmasse_v1beta1
  • user

D.1.2.24. GET /apis/user.enmasse.io/v1beta1/namespaces/{namespace}/messagingusers

D.1.2.24.1. Description

list objects of kind MessagingUser

D.1.2.24.2. Parameters
TypeNameDescriptionSchema

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Query

labelSelector
optional

A selector to restrict the list of returned objects by their labels. Defaults to everything.

string

D.1.2.24.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.user.v1beta1.MessagingUserList

401

Unauthorized

No Content

D.1.2.24.4. Produces
  • application/json
D.1.2.24.5. Tags
  • auth
  • enmasse_v1beta1
  • user

D.1.2.25. GET /apis/user.enmasse.io/v1beta1/namespaces/{namespace}/messagingusers/{name}

D.1.2.25.1. Description

read the specified MessagingUser

D.1.2.25.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of MessagingUser to read. Must include addressSpace and dot separator in the name (that is, 'myspace.user1').

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

D.1.2.25.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.user.v1beta1.MessagingUser

401

Unauthorized

No Content

404

Not found

No Content

D.1.2.25.4. Consumes
  • application/json
D.1.2.25.5. Produces
  • application/json
D.1.2.25.6. Tags
  • auth
  • enmasse_v1beta1
  • user

D.1.2.26. PUT /apis/user.enmasse.io/v1beta1/namespaces/{namespace}/messagingusers/{name}

D.1.2.26.1. Description

replace the specified MessagingUser

D.1.2.26.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of MessagingUser to replace. Must include addressSpace and dot separator in the name (that is, 'myspace.user1').

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Body

body
required

 

io.enmasse.user.v1beta1.MessagingUser

D.1.2.26.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.user.v1beta1.MessagingUser

201

Created

io.enmasse.user.v1beta1.MessagingUser

401

Unauthorized

No Content

D.1.2.26.4. Produces
  • application/json
D.1.2.26.5. Tags
  • auth
  • enmasse_v1beta1
  • user

D.1.2.27. DELETE /apis/user.enmasse.io/v1beta1/namespaces/{namespace}/messagingusers/{name}

D.1.2.27.1. Description

delete a MessagingUser

D.1.2.27.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of MessagingUser to delete. Must include addressSpace and dot separator in the name (that is, 'myspace.user1').

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

D.1.2.27.3. Responses
HTTP CodeDescriptionSchema

200

OK

Status

401

Unauthorized

No Content

404

Not found

No Content

D.1.2.27.4. Produces
  • application/json
D.1.2.27.5. Tags
  • auth
  • enmasse_v1beta1
  • user

D.1.2.28. PATCH /apis/user.enmasse.io/v1beta1/namespaces/{namespace}/messagingusers/{name}

D.1.2.28.1. Description

patches (RFC6902) the specified MessagingUser

D.1.2.28.2. Parameters
TypeNameDescriptionSchema

Path

name
required

Name of MessagingUser to replace. Must include addressSpace and dot separator in the name (that is, 'myspace.user1'

string

Path

namespace
required

object name and auth scope, such as for teams and projects

string

Body

body
required

 

JsonPatchRequest

D.1.2.28.3. Responses
HTTP CodeDescriptionSchema

200

OK

io.enmasse.user.v1beta1.MessagingUser

401

Unauthorized

No Content

D.1.2.28.4. Consumes
  • application/json-patch+json
D.1.2.28.5. Produces
  • application/json
D.1.2.28.6. Tags
  • auth
  • enmasse_v1beta1
  • user

D.1.3. Definitions

D.1.3.1. JsonPatchRequest

NameSchema

document
required

object

patch
required

< Patch > array

D.1.3.2. ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

NameSchema

name
required

string

namespace
optional

string

D.1.3.3. Patch

NameDescriptionSchema

from
optional

Required for operations copy, replace

string

op
required

 

enum (add, remove, replace, move, copy, test)

path
required

Slash separated format

string

value
optional

Required for operations add, replace, test

string

D.1.3.4. Status

Status is a return value for calls that do not return other objects.

NameDescriptionSchema

code
optional

Suggested HTTP return code for this status, 0 if not set.

integer (int32)

D.1.3.5. io.enmasse.admin.v1beta1.BrokeredInfraConfig

NameSchema

apiVersion
required

enum (admin.enmasse.io/v1beta1)

kind
required

enum (BrokeredInfraConfig)

metadata
required

ObjectMeta

spec
required

io.enmasse.admin.v1beta1.BrokeredInfraConfigSpec

D.1.3.6. io.enmasse.admin.v1beta1.BrokeredInfraConfigList

NameSchema

apiVersion
required

enum (admin.enmasse.io/v1beta1)

items
required

< io.enmasse.admin.v1beta1.BrokeredInfraConfig > array

kind
required

enum (BrokeredInfraConfigList)

D.1.3.7. io.enmasse.admin.v1beta1.BrokeredInfraConfigSpec

NameSchema

admin
optional

io.enmasse.admin.v1beta1.BrokeredInfraConfigSpecAdmin

broker
optional

io.enmasse.admin.v1beta1.BrokeredInfraConfigSpecBroker

networkPolicy
optional

networkPolicy

version
optional

string

networkPolicy

D.1.3.8. io.enmasse.admin.v1beta1.BrokeredInfraConfigSpecAdmin

NameSchema

podTemplate
optional

io.enmasse.admin.v1beta1.InfraConfigPodSpec

resources
optional

resources

resources

NameSchema

memory
optional

string

D.1.3.9. io.enmasse.admin.v1beta1.BrokeredInfraConfigSpecBroker

NameSchema

addressFullPolicy
optional

enum (PAGE, BLOCK, FAIL)

podTemplate
optional

io.enmasse.admin.v1beta1.InfraConfigPodSpec

resources
optional

resources

storageClassName
optional

string

updatePersistentVolumeClaim
optional

boolean

resources

NameSchema

memory
optional

string

storage
optional

string

D.1.3.10. io.enmasse.admin.v1beta1.InfraConfigPodSpec

NameSchema

metadata
optional

metadata

spec
optional

spec

metadata

NameSchema

labels
optional

object

spec

NameSchema

affinity
optional

object

containers
optional

< containers > array

priorityClassName
optional

string

tolerations
optional

< object > array

containers

NameSchema

resources
optional

object

D.1.3.11. io.enmasse.admin.v1beta1.StandardInfraConfig

NameSchema

apiVersion
required

enum (admin.enmasse.io/v1beta1)

kind
required

enum (StandardInfraConfig)

metadata
required

ObjectMeta

spec
required

io.enmasse.admin.v1beta1.StandardInfraConfigSpec

D.1.3.12. io.enmasse.admin.v1beta1.StandardInfraConfigList

NameSchema

apiVersion
required

enum (admin.enmasse.io/v1beta1)

items
required

< io.enmasse.admin.v1beta1.StandardInfraConfig > array

kind
required

enum (StandardInfraConfigList)

D.1.3.13. io.enmasse.admin.v1beta1.StandardInfraConfigSpec

networkPolicy

D.1.3.14. io.enmasse.admin.v1beta1.StandardInfraConfigSpecAdmin

NameSchema

podTemplate
optional

io.enmasse.admin.v1beta1.InfraConfigPodSpec

resources
optional

resources

resources

NameSchema

memory
optional

string

D.1.3.15. io.enmasse.admin.v1beta1.StandardInfraConfigSpecBroker

NameSchema

addressFullPolicy
optional

enum (PAGE, BLOCK, FAIL)

connectorIdleTimeout
optional

integer

connectorWorkerThreads
optional

integer

podTemplate
optional

io.enmasse.admin.v1beta1.InfraConfigPodSpec

resources
optional

resources

storageClassName
optional

string

updatePersistentVolumeClaim
optional

boolean

resources

NameSchema

memory
optional

string

storage
optional

string

D.1.3.16. io.enmasse.admin.v1beta1.StandardInfraConfigSpecRouter

NameSchema

idleTimeout
optional

integer

initialHandshakeTimeout
optional

integer

linkCapacity
optional

integer

minReplicas
optional

integer

podTemplate
optional

io.enmasse.admin.v1beta1.InfraConfigPodSpec

policy
optional

policy

resources
optional

resources

workerThreads
optional

integer

policy

NameSchema

maxConnections
optional

integer

maxConnectionsPerHost
optional

integer

maxConnectionsPerUser
optional

integer

maxReceiversPerConnection
optional

integer

maxSendersPerConnection
optional

integer

maxSessionsPerConnection
optional

integer

resources

NameSchema

memory
optional

string

D.1.3.17. io.enmasse.admin.v1beta2.AddressPlan

NameSchema

apiVersion
required

enum (admin.enmasse.io/v1beta2)

kind
required

enum (AddressPlan)

metadata
required

ObjectMeta

spec
required

io.enmasse.admin.v1beta2.AddressPlanSpec

D.1.3.18. io.enmasse.admin.v1beta2.AddressPlanList

NameSchema

apiVersion
required

enum (admin.enmasse.io/v1beta2)

items
required

< io.enmasse.admin.v1beta2.AddressPlan > array

kind
required

enum (AddressPlanList)

D.1.3.19. io.enmasse.admin.v1beta2.AddressPlanSpec

NameSchema

addressType
required

string

displayName
required

string

displayOrder
optional

integer

longDescription
optional

string

partitions
optional

integer

resources
required

resources

shortDescription
optional

string

resources

NameSchema

broker
optional

number

router
optional

number

D.1.3.20. io.enmasse.admin.v1beta2.AddressSpacePlan

NameSchema

apiVersion
required

enum (admin.enmasse.io/v1beta2)

kind
required

enum (AddressSpacePlan)

metadata
required

ObjectMeta

spec
required

io.enmasse.admin.v1beta2.AddressSpacePlanSpec

D.1.3.21. io.enmasse.admin.v1beta2.AddressSpacePlanList

NameSchema

apiVersion
required

enum (admin.enmasse.io/v1beta2)

items
required

< io.enmasse.admin.v1beta2.AddressSpacePlan > array

kind
required

enum (AddressSpacePlanList)

D.1.3.22. io.enmasse.admin.v1beta2.AddressSpacePlanSpec

NameSchema

addressPlans
required

< string > array

addressSpaceType
required

string

displayName
required

string

displayOrder
optional

integer

infraConfigRef
required

string

longDescription
optional

string

resourceLimits
required

resourceLimits

shortDescription
optional

string

resourceLimits

NameSchema

aggregate
optional

number

broker
optional

number

router
optional

number

D.1.3.23. io.enmasse.user.v1beta1.MessagingUser

NameSchema

apiVersion
required

enum (user.enmasse.io/v1beta1)

kind
required

enum (MessagingUser)

metadata
required

ObjectMeta

spec
required

io.enmasse.user.v1beta1.UserSpec

D.1.3.24. io.enmasse.user.v1beta1.MessagingUserList

NameSchema

apiVersion
required

enum (user.enmasse.io/v1beta1)

items
required

< io.enmasse.user.v1beta1.MessagingUser > array

kind
required

enum (MessagingUserList)

D.1.3.25. io.enmasse.user.v1beta1.UserSpec

NameSchema

authentication
optional

authentication

authorization
optional

< authorization > array

username
required

string

authentication

NameDescriptionSchema

federatedUserid
optional

User id of the user to federate when 'federated' type is specified.

string

federatedUsername
optional

User name of the user to federate when 'federated' type is specified.

string

password
optional

Base64 encoded value of password when 'password' type is specified.

string

provider
optional

Name of provider to use for federated identity when 'federated' type is specified.

string

type
required

 

enum (password, serviceaccount)

authorization

NameSchema

addresses
optional

< string > array

operations
required

< enum (send, receive, view, manage) > array

D.1.3.26. io.enmasse.v1beta1.Address

NameSchema

apiVersion
required

enum (enmasse.io/v1beta1)

kind
required

enum (Address)

metadata
required

ObjectMeta

spec
required

io.enmasse.v1beta1.AddressSpec

status
optional

io.enmasse.v1beta1.AddressStatus

D.1.3.27. io.enmasse.v1beta1.AddressList

NameDescriptionSchema

apiVersion
required

Default : "enmasse.io/v1beta1"

enum (enmasse.io/v1beta1)

items
required

 

< io.enmasse.v1beta1.Address > array

kind
required

 

enum (AddressList)

D.1.3.28. io.enmasse.v1beta1.AddressSpace

NameSchema

apiVersion
required

enum (enmasse.io/v1beta1)

kind
required

enum (AddressSpace)

metadata
required

ObjectMeta

spec
required

io.enmasse.v1beta1.AddressSpaceSpec

status
optional

io.enmasse.v1beta1.AddressSpaceStatus

D.1.3.29. io.enmasse.v1beta1.AddressSpaceList

NameDescriptionSchema

apiVersion
required

Default : "enmasse.io/v1beta1"

enum (enmasse.io/v1beta1)

items
required

 

< io.enmasse.v1beta1.AddressSpace > array

kind
required

 

enum (AddressSpaceList)

D.1.3.30. io.enmasse.v1beta1.AddressSpaceSpec

NameSchema

authenticationService
optional

authenticationService

endpoints
optional

< endpoints > array

networkPolicy
optional

networkPolicy

plan
required

string

type
required

io.enmasse.v1beta1.AddressSpaceType

authenticationService

NameSchema

name
optional

string

overrides
optional

overrides

type
optional

string

overrides

NameSchema

host
optional

string

port
optional

integer

realm
optional

string

endpoints

NameSchema

cert
optional

cert

exports
optional

< exports > array

expose
optional

expose

name
optional

string

service
optional

string

cert

NameSchema

provider
optional

string

secretName
optional

string

tlsCert
optional

string

tlsKey
optional

string

exports

NameSchema

kind
optional

enum (ConfigMap, Secret, Service)

name
optional

string

expose

NameSchema

annotations
optional

object

loadBalancerPorts
optional

< string > array

loadBalancerSourceRanges
optional

< string > array

routeHost
optional

string

routeServicePort
optional

string

routeTlsTermination
optional

string

type
optional

enum (route, loadbalancer)

networkPolicy

D.1.3.31. io.enmasse.v1beta1.AddressSpaceStatus

NameSchema

endpointStatuses
optional

< endpointStatuses > array

isReady
optional

boolean

messages
optional

< string > array

endpointStatuses

NameSchema

cert
optional

string

externalHost
optional

string

externalPorts
optional

< externalPorts > array

name
optional

string

serviceHost
optional

string

servicePorts
optional

< servicePorts > array

externalPorts

NameSchema

name
optional

string

port
optional

integer

servicePorts

NameSchema

name
optional

string

port
optional

integer

D.1.3.32. io.enmasse.v1beta1.AddressSpaceType

AddressSpaceType is the type of address space (standard, brokered). Each type supports different types of addresses and semantics for those types.

Type : enum (standard, brokered)

D.1.3.33. io.enmasse.v1beta1.AddressSpec

NameSchema

address
required

string

plan
required

string

type
required

io.enmasse.v1beta1.AddressType

D.1.3.34. io.enmasse.v1beta1.AddressStatus

NameSchema

isReady
optional

boolean

messages
optional

< string > array

phase
optional

enum (Pending, Configuring, Active, Failed, Terminating)

D.1.3.35. io.enmasse.v1beta1.AddressType

Type of address (queue, topic, …). Each address type support different kinds of messaging semantics.

Type : enum (queue, topic, anycast, multicast)

D.1.3.36. io.k8s.api.networking.v1.IPBlock

IPBlock describes a particular CIDR (Ex. "192.168.1.1/24") that is allowed to the pods matched by a NetworkPolicySpec’s podSelector. The except entry describes CIDRs that should not be included within this rule.

NameDescriptionSchema

cidr
required

CIDR is a string representing the IP Block Valid examples are "192.168.1.1/24"

string

except
optional

Except is a slice of CIDRs that should not be included within an IP Block Valid examples are "192.168.1.1/24" Except values will be rejected if they are outside the CIDR range

< string > array

D.1.3.37. io.k8s.api.networking.v1.NetworkPolicyEgressRule

NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec’s podSelector. The traffic must match both ports and to. This type is beta-level in 1.8

NameDescriptionSchema

ports
optional

List of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.

< io.k8s.api.networking.v1.NetworkPolicyPort > array

to
optional

List of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list.

< io.k8s.api.networking.v1.NetworkPolicyPeer > array

D.1.3.38. io.k8s.api.networking.v1.NetworkPolicyIngressRule

NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec’s podSelector. The traffic must match both ports and from.

NameDescriptionSchema

from
optional

List of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least on item, this rule allows traffic only if the traffic matches at least one item in the from list.

< io.k8s.api.networking.v1.NetworkPolicyPeer > array

ports
optional

List of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list.

< io.k8s.api.networking.v1.NetworkPolicyPort > array

D.1.3.39. io.k8s.api.networking.v1.NetworkPolicyPeer

NetworkPolicyPeer describes a peer to allow traffic from. Only certain combinations of fields are allowed

NameDescriptionSchema

ipBlock
optional

IPBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be.

io.k8s.api.networking.v1.IPBlock

namespaceSelector
optional

Selects Namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces.

If PodSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

podSelector
optional

This is a label selector which selects Pods. This field follows standard label selector semantics; if present but empty, it selects all pods.

If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the Pods matching PodSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the Pods matching PodSelector in the policy’s own Namespace.

io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

D.1.3.40. io.k8s.api.networking.v1.NetworkPolicyPort

NetworkPolicyPort describes a port to allow traffic on

NameDescriptionSchema

port
optional

The port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers.

io.k8s.apimachinery.pkg.util.intstr.IntOrString

protocol
optional

The protocol (TCP or UDP) which traffic must match. If not specified, this field defaults to TCP.

string

D.1.3.41. io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

NameDescriptionSchema

matchExpressions
optional

matchExpressions is a list of label selector requirements. The requirements are ANDed.

< io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement > array

matchLabels
optional

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

< string, string > map

D.1.3.42. io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

NameDescriptionSchema

key
required

key is the label key that the selector applies to.

string

operator
required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

string

values
optional

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

< string > array

D.1.3.43. io.k8s.apimachinery.pkg.util.intstr.IntOrString

IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.

Type : string (int-or-string)