= AMQ Online REST API


[[_overview]]
== Overview
This is the AMQ Online API specification.


=== Version information
[%hardbreaks]
__Version__ : 0.30-SNAPSHOT


=== URI scheme
[%hardbreaks]
__Schemes__ : HTTPS


=== 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.


=== External Docs
[%hardbreaks]
__Description__ : Find out more about EnMasse
__URL__ : https://enmasse.io/documentation/




[[_paths]]
== Paths

[[_createadminenmassev1beta2namespacedaddressspaceplan]]
=== POST /apis/admin.enmasse.io/v1beta2/namespaces/{namespace}/addressspaceplans

==== Description
create an AddressSpacePlan


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__||<<_io_enmasse_admin_v1beta2_addressspaceplan,io.enmasse.admin.v1beta2.AddressSpacePlan>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_admin_v1beta2_addressspaceplan,io.enmasse.admin.v1beta2.AddressSpacePlan>>
|**201**|Created|<<_io_enmasse_admin_v1beta2_addressspaceplan,io.enmasse.admin.v1beta2.AddressSpacePlan>>
|**401**|Unauthorized|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addressspaceplan
* admin
* enmasse_v1beta2


[[_listadminenmassev1beta2namespacedaddresspaceplan]]
=== GET /apis/admin.enmasse.io/v1beta2/namespaces/{namespace}/addressspaceplans

==== Description
list objects of kind AddressSpacePlan


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_admin_v1beta2_addressspaceplanlist,io.enmasse.admin.v1beta2.AddressSpacePlanList>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspaceplan
* admin
* enmasse_v1beta2


[[_readadminenmassev1beta2namespacedaddressspaceplan]]
=== GET /apis/admin.enmasse.io/v1beta2/namespaces/{namespace}/addressspaceplans/{name}

==== Description
read the specified AddressSpacePlan


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of AddressSpacePlan to read.|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_admin_v1beta2_addressspaceplan,io.enmasse.admin.v1beta2.AddressSpacePlan>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addressspaceplan
* admin
* enmasse_v1beta2


[[_replaceadminenmassev1beta2namespacedaddressspaceplan]]
=== PUT /apis/admin.enmasse.io/v1beta2/namespaces/{namespace}/addressspaceplans/{name}

==== Description
replace the specified AddressSpacePlan


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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,io.enmasse.admin.v1beta2.AddressSpacePlan>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_admin_v1beta2_addressspaceplan,io.enmasse.admin.v1beta2.AddressSpacePlan>>
|**201**|Created|<<_io_enmasse_admin_v1beta2_addressspaceplan,io.enmasse.admin.v1beta2.AddressSpacePlan>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspaceplan
* admin
* enmasse_v1beta2


[[_deleteadminenmassev1beta2namespacedaddressspaceplan]]
=== DELETE /apis/admin.enmasse.io/v1beta2/namespaces/{namespace}/addressspaceplans/{name}

==== Description
delete an AddressSpacePlan


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of AddressSpacePlan to delete.|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_status,Status>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspaceplan
* admin
* enmasse_v1beta2


[[_createenmassev1alpha1namespacedaddress]]
=== POST /apis/enmasse.io/v1beta1/namespaces/{namespace}/addresses

==== Description
create an Address


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__||<<_io_enmasse_v1beta1_address,io.enmasse.v1beta1.Address>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1beta1_address,io.enmasse.v1beta1.Address>>
|**201**|Created|<<_io_enmasse_v1beta1_address,io.enmasse.v1beta1.Address>>
|**401**|Unauthorized|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addresses
* enmasse_v1beta1


[[_listenmassev1alpha1namespacedaddress]]
=== GET /apis/enmasse.io/v1beta1/namespaces/{namespace}/addresses

==== Description
list objects of kind Address


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1beta1_addresslist,io.enmasse.v1beta1.AddressList>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* addresses
* enmasse_v1beta1


[[_readenmassev1alpha1namespacedaddress]]
=== GET /apis/enmasse.io/v1beta1/namespaces/{namespace}/addresses/{name}

==== Description
read the specified Address


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of Address to read|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1beta1_address,io.enmasse.v1beta1.Address>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addresses
* enmasse_v1beta1


[[_replaceenmassev1alpha1namespacedaddress]]
=== PUT /apis/enmasse.io/v1beta1/namespaces/{namespace}/addresses/{name}

==== Description
replace the specified Address


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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,io.enmasse.v1beta1.Address>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1beta1_address,io.enmasse.v1beta1.Address>>
|**201**|Created|<<_io_enmasse_v1beta1_address,io.enmasse.v1beta1.Address>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* addresses
* enmasse_v1beta1


[[_deleteenmassev1alpha1namespacedaddress]]
=== DELETE /apis/enmasse.io/v1beta1/namespaces/{namespace}/addresses/{name}

==== Description
delete an Address


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of Address to delete|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_status,Status>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* addresses
* enmasse_v1beta1


[[_patchesenmassev1alpha1namespacedaddress]]
=== PATCH /apis/enmasse.io/v1beta1/namespaces/{namespace}/addresses/{name}

==== Description
patches (RFC6902) the specified Address


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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,JsonPatchRequest>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1beta1_address,io.enmasse.v1beta1.Address>>
|**401**|Unauthorized|No Content
|===


==== Consumes

* `application/json-patch+json`


==== Produces

* `application/json`


==== Tags

* addresses
* enmasse_v1beta1


[[_createenmassev1alpha1namespacedaddressspace]]
=== POST /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces

==== Description
create an AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__||<<_io_enmasse_v1beta1_addressspace,io.enmasse.v1beta1.AddressSpace>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1beta1_addressspace,io.enmasse.v1beta1.AddressSpace>>
|**201**|Created|<<_io_enmasse_v1beta1_addressspace,io.enmasse.v1beta1.AddressSpace>>
|**401**|Unauthorized|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addressspaces
* enmasse_v1beta1


[[_listenmassev1alpha1namespacedaddressspace]]
=== GET /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces

==== Description
list objects of kind AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1beta1_addressspacelist,io.enmasse.v1beta1.AddressSpaceList>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspaces
* enmasse_v1beta1


[[_createenmassev1alpha1addressspaceaddresses]]
=== POST /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses

==== Description
create Addresses in an AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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,io.enmasse.v1beta1.AddressList>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_status,Status>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addressspace_addresses
* enmasse_v1beta1


[[_listenmassev1alpha1namespacedaddressspaceaddress]]
=== GET /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses

==== Description
list objects of kind Address in AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**addressSpace** +
__required__|Name of AddressSpace|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1beta1_addresslist,io.enmasse.v1beta1.AddressList>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspace_addresses
* enmasse_v1beta1


[[_readenmassev1alpha1namespacedaddressspaceaddress]]
=== GET /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses/{address}

==== Description
read the specified Address in AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1beta1_address,io.enmasse.v1beta1.Address>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspace_addresses
* enmasse_v1beta1


[[_replaceenmassev1alpha1namespacedaddressspaceaddress]]
=== PUT /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses/{address}

==== Description
replace Address in an AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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,io.enmasse.v1beta1.Address>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1beta1_address,io.enmasse.v1beta1.Address>>
|**201**|Created|<<_io_enmasse_v1beta1_address,io.enmasse.v1beta1.Address>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addressspace_addresses
* enmasse_v1beta1


[[_deleteenmassev1alpha1namespacedaddressspaceaddress]]
=== DELETE /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{addressSpace}/addresses/{address}

==== Description
delete an Address in AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_status,Status>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspace_addresses
* enmasse_v1beta1


[[_readenmassev1alpha1namespacedaddressspace]]
=== GET /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{name}

==== Description
read the specified AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of AddressSpace to read|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1beta1_addressspace,io.enmasse.v1beta1.AddressSpace>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* addressspaces
* enmasse_v1beta1


[[_replaceenmassev1alpha1namespacedaddressspace]]
=== PUT /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{name}

==== Description
replace the specified AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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,io.enmasse.v1beta1.AddressSpace>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1beta1_addressspace,io.enmasse.v1beta1.AddressSpace>>
|**201**|Created|<<_io_enmasse_v1beta1_addressspace,io.enmasse.v1beta1.AddressSpace>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspaces
* enmasse_v1beta1


[[_deleteenmassev1alpha1namespacedaddressspace]]
=== DELETE /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{name}

==== Description
delete an AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**name** +
__required__|Name of AddressSpace to delete|string
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_status,Status>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* addressspaces
* enmasse_v1beta1


[[_patchesenmassev1alpha1namespacedaddressspace]]
=== PATCH /apis/enmasse.io/v1beta1/namespaces/{namespace}/addressspaces/{name}

==== Description
patches (RFC6902) the specified AddressSpace


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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,JsonPatchRequest>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_v1beta1_addressspace,io.enmasse.v1beta1.AddressSpace>>
|**401**|Unauthorized|No Content
|===


==== Consumes

* `application/json-patch+json`


==== Produces

* `application/json`


==== Tags

* addressspaces
* enmasse_v1beta1


[[_createauthenmassev1alpha1namespacedmessaginguser]]
=== POST /apis/user.enmasse.io/v1beta1/namespaces/{namespace}/messagingusers

==== Description
create a MessagingUser


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**Path**|**namespace** +
__required__|object name and auth scope, such as for teams and projects|string
|**Body**|**body** +
__required__||<<_io_enmasse_user_v1beta1_messaginguser,io.enmasse.user.v1beta1.MessagingUser>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_user_v1beta1_messaginguser,io.enmasse.user.v1beta1.MessagingUser>>
|**201**|Created|<<_io_enmasse_user_v1beta1_messaginguser,io.enmasse.user.v1beta1.MessagingUser>>
|**401**|Unauthorized|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* auth
* enmasse_v1beta1
* user


[[_listauthenmassev1alpha1namespacedmessaginguser]]
=== GET /apis/user.enmasse.io/v1beta1/namespaces/{namespace}/messagingusers

==== Description
list objects of kind MessagingUser


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_user_v1beta1_messaginguserlist,io.enmasse.user.v1beta1.MessagingUserList>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* auth
* enmasse_v1beta1
* user


[[_readauthenmassev1alpha1namespacedmessaginguser]]
=== GET /apis/user.enmasse.io/v1beta1/namespaces/{namespace}/messagingusers/{name}

==== Description
read the specified MessagingUser


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_user_v1beta1_messaginguser,io.enmasse.user.v1beta1.MessagingUser>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Consumes

* `application/json`


==== Produces

* `application/json`


==== Tags

* auth
* enmasse_v1beta1
* user


[[_replaceauthenmassev1alpha1namespacedmessaginguser]]
=== PUT /apis/user.enmasse.io/v1beta1/namespaces/{namespace}/messagingusers/{name}

==== Description
replace the specified MessagingUser


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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,io.enmasse.user.v1beta1.MessagingUser>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_user_v1beta1_messaginguser,io.enmasse.user.v1beta1.MessagingUser>>
|**201**|Created|<<_io_enmasse_user_v1beta1_messaginguser,io.enmasse.user.v1beta1.MessagingUser>>
|**401**|Unauthorized|No Content
|===


==== Produces

* `application/json`


==== Tags

* auth
* enmasse_v1beta1
* user


[[_deleteauthenmassev1alpha1namespacedmessaginguser]]
=== DELETE /apis/user.enmasse.io/v1beta1/namespaces/{namespace}/messagingusers/{name}

==== Description
delete a MessagingUser


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_status,Status>>
|**401**|Unauthorized|No Content
|**404**|Not found|No Content
|===


==== Produces

* `application/json`


==== Tags

* auth
* enmasse_v1beta1
* user


[[_patchesenmassev1alpha1namespacedmessaginguser]]
=== PATCH /apis/user.enmasse.io/v1beta1/namespaces/{namespace}/messagingusers/{name}

==== Description
patches (RFC6902) the specified MessagingUser


==== Parameters

[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|Type|Name|Description|Schema
|**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,JsonPatchRequest>>
|===


==== Responses

[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP Code|Description|Schema
|**200**|OK|<<_io_enmasse_user_v1beta1_messaginguser,io.enmasse.user.v1beta1.MessagingUser>>
|**401**|Unauthorized|No Content
|===


==== Consumes

* `application/json-patch+json`


==== Produces

* `application/json`


==== Tags

* auth
* enmasse_v1beta1
* user




[[_definitions]]
== Definitions

[[_jsonpatchrequest]]
=== JsonPatchRequest

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**document** +
__required__|object
|**patch** +
__required__|< <<_patch,Patch>> > array
|===


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


[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**name** +
__required__|string
|**namespace** +
__optional__|string
|===


[[_patch]]
=== Patch

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**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
|===


[[_status]]
=== Status
Status is a return value for calls that do not return other objects.


[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**code** +
__optional__|Suggested HTTP return code for this status, 0 if not set.|integer (int32)
|===


[[_io_enmasse_admin_v1beta1_brokeredinfraconfig]]
=== io.enmasse.admin.v1beta1.BrokeredInfraConfig

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1beta1)
|**kind** +
__required__|enum (BrokeredInfraConfig)
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**spec** +
__required__|<<_io_enmasse_admin_v1beta1_brokeredinfraconfigspec,io.enmasse.admin.v1beta1.BrokeredInfraConfigSpec>>
|===


[[_io_enmasse_admin_v1beta1_brokeredinfraconfiglist]]
=== io.enmasse.admin.v1beta1.BrokeredInfraConfigList

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1beta1)
|**items** +
__required__|< <<_io_enmasse_admin_v1beta1_brokeredinfraconfig,io.enmasse.admin.v1beta1.BrokeredInfraConfig>> > array
|**kind** +
__required__|enum (BrokeredInfraConfigList)
|===


[[_io_enmasse_admin_v1beta1_brokeredinfraconfigspec]]
=== io.enmasse.admin.v1beta1.BrokeredInfraConfigSpec

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**admin** +
__optional__|<<_io_enmasse_admin_v1beta1_brokeredinfraconfigspecadmin,io.enmasse.admin.v1beta1.BrokeredInfraConfigSpecAdmin>>
|**broker** +
__optional__|<<_io_enmasse_admin_v1beta1_brokeredinfraconfigspecbroker,io.enmasse.admin.v1beta1.BrokeredInfraConfigSpecBroker>>
|**networkPolicy** +
__optional__|<<_io_enmasse_admin_v1beta1_brokeredinfraconfigspec_networkpolicy,networkPolicy>>
|**version** +
__optional__|string
|===

[[_io_enmasse_admin_v1beta1_brokeredinfraconfigspec_networkpolicy]]
**networkPolicy**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**egress** +
__optional__|< <<_io_k8s_api_networking_v1_networkpolicyegressrule,io.k8s.api.networking.v1.NetworkPolicyEgressRule>> > array
|**ingress** +
__optional__|< <<_io_k8s_api_networking_v1_networkpolicyingressrule,io.k8s.api.networking.v1.NetworkPolicyIngressRule>> > array
|===


[[_io_enmasse_admin_v1beta1_brokeredinfraconfigspecadmin]]
=== io.enmasse.admin.v1beta1.BrokeredInfraConfigSpecAdmin

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**podTemplate** +
__optional__|<<_io_enmasse_admin_v1beta1_infraconfigpodspec,io.enmasse.admin.v1beta1.InfraConfigPodSpec>>
|**resources** +
__optional__|<<_io_enmasse_admin_v1beta1_brokeredinfraconfigspecadmin_resources,resources>>
|===

[[_io_enmasse_admin_v1beta1_brokeredinfraconfigspecadmin_resources]]
**resources**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**memory** +
__optional__|string
|===


[[_io_enmasse_admin_v1beta1_brokeredinfraconfigspecbroker]]
=== io.enmasse.admin.v1beta1.BrokeredInfraConfigSpecBroker

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**addressFullPolicy** +
__optional__|enum (PAGE, BLOCK, FAIL)
|**podTemplate** +
__optional__|<<_io_enmasse_admin_v1beta1_infraconfigpodspec,io.enmasse.admin.v1beta1.InfraConfigPodSpec>>
|**resources** +
__optional__|<<_io_enmasse_admin_v1beta1_brokeredinfraconfigspecbroker_resources,resources>>
|**storageClassName** +
__optional__|string
|**updatePersistentVolumeClaim** +
__optional__|boolean
|===

[[_io_enmasse_admin_v1beta1_brokeredinfraconfigspecbroker_resources]]
**resources**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**memory** +
__optional__|string
|**storage** +
__optional__|string
|===


[[_io_enmasse_admin_v1beta1_infraconfigpodspec]]
=== io.enmasse.admin.v1beta1.InfraConfigPodSpec

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**metadata** +
__optional__|<<_io_enmasse_admin_v1beta1_infraconfigpodspec_metadata,metadata>>
|**spec** +
__optional__|<<_io_enmasse_admin_v1beta1_infraconfigpodspec_spec,spec>>
|===

[[_io_enmasse_admin_v1beta1_infraconfigpodspec_metadata]]
**metadata**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**labels** +
__optional__|object
|===

[[_io_enmasse_admin_v1beta1_infraconfigpodspec_spec]]
**spec**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**affinity** +
__optional__|object
|**containers** +
__optional__|< <<_io_enmasse_admin_v1beta1_infraconfigpodspec_containers,containers>> > array
|**priorityClassName** +
__optional__|string
|**tolerations** +
__optional__|< object > array
|===

[[_io_enmasse_admin_v1beta1_infraconfigpodspec_containers]]
**containers**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**resources** +
__optional__|object
|===


[[_io_enmasse_admin_v1beta1_standardinfraconfig]]
=== io.enmasse.admin.v1beta1.StandardInfraConfig

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1beta1)
|**kind** +
__required__|enum (StandardInfraConfig)
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**spec** +
__required__|<<_io_enmasse_admin_v1beta1_standardinfraconfigspec,io.enmasse.admin.v1beta1.StandardInfraConfigSpec>>
|===


[[_io_enmasse_admin_v1beta1_standardinfraconfiglist]]
=== io.enmasse.admin.v1beta1.StandardInfraConfigList

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1beta1)
|**items** +
__required__|< <<_io_enmasse_admin_v1beta1_standardinfraconfig,io.enmasse.admin.v1beta1.StandardInfraConfig>> > array
|**kind** +
__required__|enum (StandardInfraConfigList)
|===


[[_io_enmasse_admin_v1beta1_standardinfraconfigspec]]
=== io.enmasse.admin.v1beta1.StandardInfraConfigSpec

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**admin** +
__optional__|<<_io_enmasse_admin_v1beta1_standardinfraconfigspecadmin,io.enmasse.admin.v1beta1.StandardInfraConfigSpecAdmin>>
|**broker** +
__optional__|<<_io_enmasse_admin_v1beta1_standardinfraconfigspecbroker,io.enmasse.admin.v1beta1.StandardInfraConfigSpecBroker>>
|**networkPolicy** +
__optional__|<<_io_enmasse_admin_v1beta1_standardinfraconfigspec_networkpolicy,networkPolicy>>
|**router** +
__optional__|<<_io_enmasse_admin_v1beta1_standardinfraconfigspecrouter,io.enmasse.admin.v1beta1.StandardInfraConfigSpecRouter>>
|**version** +
__optional__|string
|===

[[_io_enmasse_admin_v1beta1_standardinfraconfigspec_networkpolicy]]
**networkPolicy**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**egress** +
__optional__|< <<_io_k8s_api_networking_v1_networkpolicyegressrule,io.k8s.api.networking.v1.NetworkPolicyEgressRule>> > array
|**ingress** +
__optional__|< <<_io_k8s_api_networking_v1_networkpolicyingressrule,io.k8s.api.networking.v1.NetworkPolicyIngressRule>> > array
|===


[[_io_enmasse_admin_v1beta1_standardinfraconfigspecadmin]]
=== io.enmasse.admin.v1beta1.StandardInfraConfigSpecAdmin

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**podTemplate** +
__optional__|<<_io_enmasse_admin_v1beta1_infraconfigpodspec,io.enmasse.admin.v1beta1.InfraConfigPodSpec>>
|**resources** +
__optional__|<<_io_enmasse_admin_v1beta1_standardinfraconfigspecadmin_resources,resources>>
|===

[[_io_enmasse_admin_v1beta1_standardinfraconfigspecadmin_resources]]
**resources**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**memory** +
__optional__|string
|===


[[_io_enmasse_admin_v1beta1_standardinfraconfigspecbroker]]
=== io.enmasse.admin.v1beta1.StandardInfraConfigSpecBroker

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**addressFullPolicy** +
__optional__|enum (PAGE, BLOCK, FAIL)
|**connectorIdleTimeout** +
__optional__|integer
|**connectorWorkerThreads** +
__optional__|integer
|**podTemplate** +
__optional__|<<_io_enmasse_admin_v1beta1_infraconfigpodspec,io.enmasse.admin.v1beta1.InfraConfigPodSpec>>
|**resources** +
__optional__|<<_io_enmasse_admin_v1beta1_standardinfraconfigspecbroker_resources,resources>>
|**storageClassName** +
__optional__|string
|**updatePersistentVolumeClaim** +
__optional__|boolean
|===

[[_io_enmasse_admin_v1beta1_standardinfraconfigspecbroker_resources]]
**resources**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**memory** +
__optional__|string
|**storage** +
__optional__|string
|===


[[_io_enmasse_admin_v1beta1_standardinfraconfigspecrouter]]
=== io.enmasse.admin.v1beta1.StandardInfraConfigSpecRouter

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**idleTimeout** +
__optional__|integer
|**initialHandshakeTimeout** +
__optional__|integer
|**linkCapacity** +
__optional__|integer
|**minReplicas** +
__optional__|integer
|**podTemplate** +
__optional__|<<_io_enmasse_admin_v1beta1_infraconfigpodspec,io.enmasse.admin.v1beta1.InfraConfigPodSpec>>
|**policy** +
__optional__|<<_io_enmasse_admin_v1beta1_standardinfraconfigspecrouter_policy,policy>>
|**resources** +
__optional__|<<_io_enmasse_admin_v1beta1_standardinfraconfigspecrouter_resources,resources>>
|**workerThreads** +
__optional__|integer
|===

[[_io_enmasse_admin_v1beta1_standardinfraconfigspecrouter_policy]]
**policy**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**maxConnections** +
__optional__|integer
|**maxConnectionsPerHost** +
__optional__|integer
|**maxConnectionsPerUser** +
__optional__|integer
|**maxReceiversPerConnection** +
__optional__|integer
|**maxSendersPerConnection** +
__optional__|integer
|**maxSessionsPerConnection** +
__optional__|integer
|===

[[_io_enmasse_admin_v1beta1_standardinfraconfigspecrouter_resources]]
**resources**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**memory** +
__optional__|string
|===


[[_io_enmasse_admin_v1beta2_addressplan]]
=== io.enmasse.admin.v1beta2.AddressPlan

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1beta2)
|**kind** +
__required__|enum (AddressPlan)
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**spec** +
__required__|<<_io_enmasse_admin_v1beta2_addressplanspec,io.enmasse.admin.v1beta2.AddressPlanSpec>>
|===


[[_io_enmasse_admin_v1beta2_addressplanlist]]
=== io.enmasse.admin.v1beta2.AddressPlanList

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1beta2)
|**items** +
__required__|< <<_io_enmasse_admin_v1beta2_addressplan,io.enmasse.admin.v1beta2.AddressPlan>> > array
|**kind** +
__required__|enum (AddressPlanList)
|===


[[_io_enmasse_admin_v1beta2_addressplanspec]]
=== io.enmasse.admin.v1beta2.AddressPlanSpec

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**addressType** +
__required__|string
|**displayName** +
__required__|string
|**displayOrder** +
__optional__|integer
|**longDescription** +
__optional__|string
|**partitions** +
__optional__|integer
|**resources** +
__required__|<<_io_enmasse_admin_v1beta2_addressplanspec_resources,resources>>
|**shortDescription** +
__optional__|string
|===

[[_io_enmasse_admin_v1beta2_addressplanspec_resources]]
**resources**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**broker** +
__optional__|number
|**router** +
__optional__|number
|===


[[_io_enmasse_admin_v1beta2_addressspaceplan]]
=== io.enmasse.admin.v1beta2.AddressSpacePlan

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1beta2)
|**kind** +
__required__|enum (AddressSpacePlan)
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**spec** +
__required__|<<_io_enmasse_admin_v1beta2_addressspaceplanspec,io.enmasse.admin.v1beta2.AddressSpacePlanSpec>>
|===


[[_io_enmasse_admin_v1beta2_addressspaceplanlist]]
=== io.enmasse.admin.v1beta2.AddressSpacePlanList

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (admin.enmasse.io/v1beta2)
|**items** +
__required__|< <<_io_enmasse_admin_v1beta2_addressspaceplan,io.enmasse.admin.v1beta2.AddressSpacePlan>> > array
|**kind** +
__required__|enum (AddressSpacePlanList)
|===


[[_io_enmasse_admin_v1beta2_addressspaceplanspec]]
=== io.enmasse.admin.v1beta2.AddressSpacePlanSpec

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**addressPlans** +
__required__|< string > array
|**addressSpaceType** +
__required__|string
|**displayName** +
__required__|string
|**displayOrder** +
__optional__|integer
|**infraConfigRef** +
__required__|string
|**longDescription** +
__optional__|string
|**resourceLimits** +
__required__|<<_io_enmasse_admin_v1beta2_addressspaceplanspec_resourcelimits,resourceLimits>>
|**shortDescription** +
__optional__|string
|===

[[_io_enmasse_admin_v1beta2_addressspaceplanspec_resourcelimits]]
**resourceLimits**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**aggregate** +
__optional__|number
|**broker** +
__optional__|number
|**router** +
__optional__|number
|===


[[_io_enmasse_user_v1beta1_messaginguser]]
=== io.enmasse.user.v1beta1.MessagingUser

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (user.enmasse.io/v1beta1)
|**kind** +
__required__|enum (MessagingUser)
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**spec** +
__required__|<<_io_enmasse_user_v1beta1_userspec,io.enmasse.user.v1beta1.UserSpec>>
|===


[[_io_enmasse_user_v1beta1_messaginguserlist]]
=== io.enmasse.user.v1beta1.MessagingUserList

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (user.enmasse.io/v1beta1)
|**items** +
__required__|< <<_io_enmasse_user_v1beta1_messaginguser,io.enmasse.user.v1beta1.MessagingUser>> > array
|**kind** +
__required__|enum (MessagingUserList)
|===


[[_io_enmasse_user_v1beta1_userspec]]
=== io.enmasse.user.v1beta1.UserSpec

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**authentication** +
__optional__|<<_io_enmasse_user_v1beta1_userspec_authentication,authentication>>
|**authorization** +
__optional__|< <<_io_enmasse_user_v1beta1_userspec_authorization,authorization>> > array
|**username** +
__required__|string
|===

[[_io_enmasse_user_v1beta1_userspec_authentication]]
**authentication**

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**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)
|===

[[_io_enmasse_user_v1beta1_userspec_authorization]]
**authorization**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**addresses** +
__optional__|< string > array
|**operations** +
__required__|< enum (send, receive, view, manage) > array
|===


[[_io_enmasse_v1beta1_address]]
=== io.enmasse.v1beta1.Address

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (enmasse.io/v1beta1)
|**kind** +
__required__|enum (Address)
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**spec** +
__required__|<<_io_enmasse_v1beta1_addressspec,io.enmasse.v1beta1.AddressSpec>>
|**status** +
__optional__|<<_io_enmasse_v1beta1_addressstatus,io.enmasse.v1beta1.AddressStatus>>
|===


[[_io_enmasse_v1beta1_addresslist]]
=== io.enmasse.v1beta1.AddressList

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**apiVersion** +
__required__|**Default** : `"enmasse.io/v1beta1"`|enum (enmasse.io/v1beta1)
|**items** +
__required__||< <<_io_enmasse_v1beta1_address,io.enmasse.v1beta1.Address>> > array
|**kind** +
__required__||enum (AddressList)
|===


[[_io_enmasse_v1beta1_addressspace]]
=== io.enmasse.v1beta1.AddressSpace

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**apiVersion** +
__required__|enum (enmasse.io/v1beta1)
|**kind** +
__required__|enum (AddressSpace)
|**metadata** +
__required__|<<_objectmeta,ObjectMeta>>
|**spec** +
__required__|<<_io_enmasse_v1beta1_addressspacespec,io.enmasse.v1beta1.AddressSpaceSpec>>
|**status** +
__optional__|<<_io_enmasse_v1beta1_addressspacestatus,io.enmasse.v1beta1.AddressSpaceStatus>>
|===


[[_io_enmasse_v1beta1_addressspacelist]]
=== io.enmasse.v1beta1.AddressSpaceList

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**apiVersion** +
__required__|**Default** : `"enmasse.io/v1beta1"`|enum (enmasse.io/v1beta1)
|**items** +
__required__||< <<_io_enmasse_v1beta1_addressspace,io.enmasse.v1beta1.AddressSpace>> > array
|**kind** +
__required__||enum (AddressSpaceList)
|===


[[_io_enmasse_v1beta1_addressspacespec]]
=== io.enmasse.v1beta1.AddressSpaceSpec

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**authenticationService** +
__optional__||<<_io_enmasse_v1beta1_addressspacespec_authenticationservice,authenticationService>>
|**connectors** +
__optional__|List of connectors to create.|< <<_io_enmasse_v1beta1_addressspacespecconnector,io.enmasse.v1beta1.AddressSpaceSpecConnector>> > array
|**endpoints** +
__optional__||< <<_io_enmasse_v1beta1_addressspacespec_endpoints,endpoints>> > array
|**networkPolicy** +
__optional__||<<_io_enmasse_v1beta1_addressspacespec_networkpolicy,networkPolicy>>
|**plan** +
__required__||string
|**type** +
__required__||<<_io_enmasse_v1beta1_addressspacetype,io.enmasse.v1beta1.AddressSpaceType>>
|===

[[_io_enmasse_v1beta1_addressspacespec_authenticationservice]]
**authenticationService**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**name** +
__optional__|string
|**overrides** +
__optional__|<<_io_enmasse_v1beta1_addressspacespec_overrides,overrides>>
|**type** +
__optional__|string
|===

[[_io_enmasse_v1beta1_addressspacespec_overrides]]
**overrides**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**host** +
__optional__|string
|**port** +
__optional__|integer
|**realm** +
__optional__|string
|===

[[_io_enmasse_v1beta1_addressspacespec_endpoints]]
**endpoints**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**cert** +
__optional__|<<_io_enmasse_v1beta1_addressspacespec_cert,cert>>
|**exports** +
__optional__|< <<_io_enmasse_v1beta1_addressspacespec_exports,exports>> > array
|**expose** +
__optional__|<<_io_enmasse_v1beta1_addressspacespec_expose,expose>>
|**name** +
__optional__|string
|**service** +
__optional__|string
|===

[[_io_enmasse_v1beta1_addressspacespec_cert]]
**cert**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**provider** +
__optional__|string
|**secretName** +
__optional__|string
|**tlsCert** +
__optional__|string
|**tlsKey** +
__optional__|string
|===

[[_io_enmasse_v1beta1_addressspacespec_exports]]
**exports**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**kind** +
__optional__|enum (ConfigMap, Secret, Service)
|**name** +
__optional__|string
|===

[[_io_enmasse_v1beta1_addressspacespec_expose]]
**expose**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**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)
|===

[[_io_enmasse_v1beta1_addressspacespec_networkpolicy]]
**networkPolicy**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**egress** +
__optional__|< <<_io_k8s_api_networking_v1_networkpolicyegressrule,io.k8s.api.networking.v1.NetworkPolicyEgressRule>> > array
|**ingress** +
__optional__|< <<_io_k8s_api_networking_v1_networkpolicyingressrule,io.k8s.api.networking.v1.NetworkPolicyIngressRule>> > array
|===


[[_io_enmasse_v1beta1_addressspacespecconnector]]
=== io.enmasse.v1beta1.AddressSpaceSpecConnector

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**addresses** +
__optional__|Addresses to make be accessible via this address space.|< <<_io_enmasse_v1beta1_addressspacespecconnector_addresses,addresses>> > array
|**credentials** +
__optional__|Credentials used when connecting to endpoints. Either 'username' and 'password', or 'secret' must be defined.|<<_io_enmasse_v1beta1_addressspacespecconnector_credentials,credentials>>
|**endpointHosts** +
__required__|List of hosts that should be connected to. Must contain at least 1 entry.|< <<_io_enmasse_v1beta1_addressspacespecconnector_endpointhosts,endpointHosts>> > array
|**name** +
__required__|Name of the connector.|string
|**tls** +
__optional__|TLS settings for the connectors. If not specified, TLS will not be used.|<<_io_enmasse_v1beta1_addressspacespecconnector_tls,tls>>
|===

[[_io_enmasse_v1beta1_addressspacespecconnector_addresses]]
**addresses**

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**name** +
__required__|Identifier of address pattern. Used to uniquely identify a pattern|string
|**pattern** +
__required__|Pattern used to match addresses. The pattern will be prefixed by the connector name and a forward slash ('myconnector/'). A pattern consists of one or more tokens separated by a forward slash /. A token can be one of the following: a * character, a # character, or a sequence of characters that do not include /, *, or #. The * token matches any single token. The # token matches zero or more tokens. * has higher precedence than #, and exact match has the highest precedence.|string
|===

[[_io_enmasse_v1beta1_addressspacespecconnector_credentials]]
**credentials**

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**password** +
__optional__|Password to use for connector. Either 'value' or 'secret' must be specified.|<<_io_enmasse_v1beta1_addressspacespecconnector_password,password>>
|**username** +
__optional__|Username to use for connector. Either 'value' or 'secret' must be specified.|<<_io_enmasse_v1beta1_addressspacespecconnector_username,username>>
|===

[[_io_enmasse_v1beta1_addressspacespecconnector_password]]
**password**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**value** +
__optional__|string
|**valueFromSecret** +
__optional__|<<_io_enmasse_v1beta1_addressspacespecconnector_password_valuefromsecret,valueFromSecret>>
|===

[[_io_enmasse_v1beta1_addressspacespecconnector_password_valuefromsecret]]
**valueFromSecret**

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**key** +
__optional__|Key to use for looking up password entry. +
**Default** : `"password"`|string
|**name** +
__optional__|Name of Secret containing password.|string
|===

[[_io_enmasse_v1beta1_addressspacespecconnector_username]]
**username**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**value** +
__optional__|string
|**valueFromSecret** +
__optional__|<<_io_enmasse_v1beta1_addressspacespecconnector_username_valuefromsecret,valueFromSecret>>
|===

[[_io_enmasse_v1beta1_addressspacespecconnector_username_valuefromsecret]]
**valueFromSecret**

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**key** +
__optional__|Key to use for looking up username entry. +
**Default** : `"username"`|string
|**name** +
__optional__|Name of Secret containing username.|string
|===

[[_io_enmasse_v1beta1_addressspacespecconnector_endpointhosts]]
**endpointHosts**

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**host** +
__required__|Host to connect to.|string
|**port** +
__required__|Port to connect to.|integer
|===

[[_io_enmasse_v1beta1_addressspacespecconnector_tls]]
**tls**

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**caCert** +
__optional__|CA certificate to be used by the connector. Either 'value' or 'secret'.|<<_io_enmasse_v1beta1_addressspacespecconnector_cacert,caCert>>
|**clientCert** +
__optional__|Client certificate to be used by the connector. Either 'value' or 'secret'.|<<_io_enmasse_v1beta1_addressspacespecconnector_clientcert,clientCert>>
|===

[[_io_enmasse_v1beta1_addressspacespecconnector_cacert]]
**caCert**

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**value** +
__optional__|PEM encoded value of CA certificate|string
|**valueFromSecret** +
__optional__|Secret containing CA certificate to be used by the connector.|<<_io_enmasse_v1beta1_addressspacespecconnector_cacert_valuefromsecret,valueFromSecret>>
|===

[[_io_enmasse_v1beta1_addressspacespecconnector_cacert_valuefromsecret]]
**valueFromSecret**

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**key** +
__optional__|Key to use for looking up CA certificate entry. +
**Default** : `"ca.crt"`|string
|**name** +
__optional__|Name of Secret containing CA certificate.|string
|===

[[_io_enmasse_v1beta1_addressspacespecconnector_clientcert]]
**clientCert**

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**value** +
__optional__|PEM encoded value of client certificate|string
|**valueFromSecret** +
__optional__|Secret containing client certificate to be used by the connector.|<<_io_enmasse_v1beta1_addressspacespecconnector_clientcert_valuefromsecret,valueFromSecret>>
|===

[[_io_enmasse_v1beta1_addressspacespecconnector_clientcert_valuefromsecret]]
**valueFromSecret**

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**key** +
__optional__|Key to use for looking up client certificate entry. +
**Default** : `"ca.crt"`|string
|**name** +
__optional__|Name of Secret containing client certificate.|string
|===


[[_io_enmasse_v1beta1_addressspacestatus]]
=== io.enmasse.v1beta1.AddressSpaceStatus

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**connectors** +
__optional__|List of connectors with status.|< <<_io_enmasse_v1beta1_addressspacestatusconnector,io.enmasse.v1beta1.AddressSpaceStatusConnector>> > array
|**endpointStatuses** +
__optional__||< <<_io_enmasse_v1beta1_addressspacestatus_endpointstatuses,endpointStatuses>> > array
|**isReady** +
__optional__||boolean
|**messages** +
__optional__||< string > array
|===

[[_io_enmasse_v1beta1_addressspacestatus_endpointstatuses]]
**endpointStatuses**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**cert** +
__optional__|string
|**externalHost** +
__optional__|string
|**externalPorts** +
__optional__|< <<_io_enmasse_v1beta1_addressspacestatus_externalports,externalPorts>> > array
|**name** +
__optional__|string
|**serviceHost** +
__optional__|string
|**servicePorts** +
__optional__|< <<_io_enmasse_v1beta1_addressspacestatus_serviceports,servicePorts>> > array
|===

[[_io_enmasse_v1beta1_addressspacestatus_externalports]]
**externalPorts**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**name** +
__optional__|string
|**port** +
__optional__|integer
|===

[[_io_enmasse_v1beta1_addressspacestatus_serviceports]]
**servicePorts**

[options="header", cols=".^3a,.^4a"]
|===
|Name|Schema
|**name** +
__optional__|string
|**port** +
__optional__|integer
|===


[[_io_enmasse_v1beta1_addressspacestatusconnector]]
=== io.enmasse.v1beta1.AddressSpaceStatusConnector

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**isReady** +
__optional__|'true' if connector is operating as expected, 'false' if not.|boolean
|**messages** +
__optional__|Messages describing the connector state.|< string > array
|**name** +
__optional__|Name of connector.|string
|===


[[_io_enmasse_v1beta1_addressspacetype]]
=== 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)


[[_io_enmasse_v1beta1_addressspec]]
=== io.enmasse.v1beta1.AddressSpec

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**address** +
__required__||string
|**forwarders** +
__optional__|List of forwarders to enable for this address.|< <<_io_enmasse_v1beta1_addressspecforwarder,io.enmasse.v1beta1.AddressSpecForwarder>> > array
|**plan** +
__required__||string
|**type** +
__required__||<<_io_enmasse_v1beta1_addresstype,io.enmasse.v1beta1.AddressType>>
|===


[[_io_enmasse_v1beta1_addressspecforwarder]]
=== io.enmasse.v1beta1.AddressSpecForwarder

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**direction** +
__required__|Direction of forwarder. 'in' means pulling from 'remoteAddress' into this address. 'out' means pushing from this address to 'remoteAddress'.|enum (in, out)
|**name** +
__required__|Name of forwarder.|string
|**remoteAddress** +
__required__|Remote address to send/receive messages to.|string
|===


[[_io_enmasse_v1beta1_addressstatus]]
=== io.enmasse.v1beta1.AddressStatus

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**forwarders** +
__optional__|List of forwarders with status.|< <<_io_enmasse_v1beta1_addressstatusforwarder,io.enmasse.v1beta1.AddressStatusForwarder>> > array
|**isReady** +
__optional__||boolean
|**messages** +
__optional__||< string > array
|**phase** +
__optional__||enum (Pending, Configuring, Active, Failed, Terminating)
|===


[[_io_enmasse_v1beta1_addressstatusforwarder]]
=== io.enmasse.v1beta1.AddressStatusForwarder

[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**isReady** +
__optional__|'true' if forwarder is operating as expected, 'false' if not.|boolean
|**messages** +
__optional__|Messages describing the forwarder state.|< string > array
|**name** +
__optional__|Name of forwarder.|string
|===


[[_io_enmasse_v1beta1_addresstype]]
=== io.enmasse.v1beta1.AddressType
Type of address (queue, topic, …). Each address type support different kinds of messaging semantics.

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


[[_io_k8s_api_networking_v1_ipblock]]
=== 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.


[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**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
|===


[[_io_k8s_api_networking_v1_networkpolicyegressrule]]
=== 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


[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**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,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,io.k8s.api.networking.v1.NetworkPolicyPeer>> > array
|===


[[_io_k8s_api_networking_v1_networkpolicyingressrule]]
=== 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.


[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**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,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,io.k8s.api.networking.v1.NetworkPolicyPort>> > array
|===


[[_io_k8s_api_networking_v1_networkpolicypeer]]
=== io.k8s.api.networking.v1.NetworkPolicyPeer
NetworkPolicyPeer describes a peer to allow traffic from. Only certain combinations of fields are allowed


[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**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,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,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,io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector>>
|===


[[_io_k8s_api_networking_v1_networkpolicyport]]
=== io.k8s.api.networking.v1.NetworkPolicyPort
NetworkPolicyPort describes a port to allow traffic on


[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**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,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
|===


[[_io_k8s_apimachinery_pkg_apis_meta_v1_labelselector]]
=== 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.


[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**matchExpressions** +
__optional__|matchExpressions is a list of label selector requirements. The requirements are ANDed.|< <<_io_k8s_apimachinery_pkg_apis_meta_v1_labelselectorrequirement,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
|===


[[_io_k8s_apimachinery_pkg_apis_meta_v1_labelselectorrequirement]]
=== 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.


[options="header", cols=".^3a,.^11a,.^4a"]
|===
|Name|Description|Schema
|**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
|===


[[_io_k8s_apimachinery_pkg_util_intstr_intorstring]]
=== 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)





