HostFactoryApi

HostFactoryApi

All URIs are relative to http://localhost

Method	HTTP request	Description
createHost	POST /host_factories/hosts	Creates a Host using the Host Factory.
createToken	POST /host_factory_tokens	Creates one or more host identity tokens.
revokeToken	DELETE /host_factory_tokens/{token}	Revokes a token, immediately disabling it.

createHost

CreateHost createHost(id, xRequestId, annotations)

Creates a Host using the Host Factory.

Creates a Host using the Host Factory and returns a JSON description of it. Requires a host factory token, which can be created using the create tokens API. In practice, this token is usually provided automatically as part of Conjur integration with your host provisioning infrastructure. Note: If the token was created with a CIDR restriction, you must make this API request from a whitelisted address.

Parameters

Name	Type	Description	Notes
id	String	Identifier of the host to be created. It will be created within the account of the host factory.	[default to null]
xRequestId	String	Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one.	[optional] [default to null]
annotations	Object	Annotations to apply to the new host	[optional] [default to null]

Return type

CreateHost

Authorization

conjurAuth

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: application/json

createToken

List createToken(expiration, hostFactory, xRequestId, cidr, count)

Creates one or more host identity tokens.

Creates one or more tokens which can be used to bootstrap host identity. Responds with a JSON document containing the tokens and their restrictions. If the tokens are created with a CIDR restriction, Conjur will only accept them from the whitelisted IP ranges. ##### Permissions required # execute privilege on the Host Factory."

Parameters

Name	Type	Description	Notes
expiration	String	ISO 8601 datetime denoting a requested expiration time.	[default to null]
hostFactory	String	Fully qualified host factory ID	[default to null]
xRequestId	String	Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one.	[optional] [default to null]
cidr	List	Number of host tokens to create	[optional] [default to null]
count	Integer	Number of host tokens to create	[optional] [default to null]

Return type

List

Authorization

conjurAuth

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: application/json

revokeToken

revokeToken(token, xRequestId)

Revokes a token, immediately disabling it.

Revokes a token, immediately disabling it. ##### Permissions required update privilege on the host factory."

Parameters

Name	Type	Description	Notes
token	String	The host factory token to revoke	[default to null]
xRequestId	String	Add an ID to the request being made so it can be tracked in Conjur. If not provided the server will automatically generate one.	[optional] [default to null]

Return type

null (empty response body)

Authorization

conjurAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined