Nexus
Nexus APIs
POST
/v1/applications/{applicationId}/deploymentTargets
Registers a deployment target
Requires the application.deployment_target.write permission
Parameters
| Name | In | Required | Description |
|---|---|---|---|
applicationId |
path | Yes |
Request body
Request payload
Example
{
"name": "string",
"country": "string",
"details": {},
"isActive": false,
"publicUrl": "string",
"description": "string",
"displayName": "string",
"environment": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
country
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Example
{
"name": "string",
"country": "string",
"details": {},
"isActive": false,
"publicUrl": "string",
"description": "string",
"displayName": "string",
"environment": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
country
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Example
{
"name": "string",
"country": "string",
"details": {},
"isActive": false,
"publicUrl": "string",
"description": "string",
"displayName": "string",
"environment": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
country
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Example
{
"name": "string",
"country": "string",
"details": {},
"isActive": false,
"publicUrl": "string",
"description": "string",
"displayName": "string",
"environment": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
country
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Example
{
"name": "string",
"country": "string",
"details": {},
"isActive": false,
"publicUrl": "string",
"description": "string",
"displayName": "string",
"environment": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
country
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Example
{
"name": "string",
"country": "string",
"details": {},
"isActive": false,
"publicUrl": "string",
"description": "string",
"displayName": "string",
"environment": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
country
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Example
{
"name": "string",
"country": "string",
"details": {},
"isActive": false,
"publicUrl": "string",
"description": "string",
"displayName": "string",
"environment": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
country
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Example
{
"name": "string",
"country": "string",
"details": {},
"isActive": false,
"publicUrl": "string",
"description": "string",
"displayName": "string",
"environment": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
country
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Responses
201
Example
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": {
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": {
"type": null
},
"subscriptions": [],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": null,
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": null,
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
application
|
— | — | — | |
applicationId
|
integer (int32)
|
nullable | — | — |
country
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Example
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": {
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": {
"type": null
},
"subscriptions": [],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": null,
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": null,
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
application
|
— | — | — | |
applicationId
|
integer (int32)
|
nullable | — | — |
country
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Example
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": {
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": {
"type": null
},
"subscriptions": [],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": null,
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": null,
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
application
|
— | — | — | |
applicationId
|
integer (int32)
|
nullable | — | — |
country
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Example
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": {
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": {
"type": null
},
"subscriptions": [],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": null,
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": null,
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
application
|
— | — | — | |
applicationId
|
integer (int32)
|
nullable | — | — |
country
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Example
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": {
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": {
"type": null
},
"subscriptions": [],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": null,
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": null,
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
application
|
— | — | — | |
applicationId
|
integer (int32)
|
nullable | — | — |
country
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Example
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": {
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": {
"type": null
},
"subscriptions": [],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": null,
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": null,
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
application
|
— | — | — | |
applicationId
|
integer (int32)
|
nullable | — | — |
country
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Example
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": {},
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": {
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": {
"type": null
},
"subscriptions": [],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"id": 0,
"name": "string",
"country": "string",
"created": "string",
"details": null,
"isActive": false,
"modified": "string",
"createdBy": "string",
"publicUrl": "string",
"modifiedBy": "string",
"application": null,
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}
],
"userDefaultIsActive": false
},
"description": "string",
"displayName": "string",
"environment": "string",
"applicationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
application
|
— | — | — | |
applicationId
|
integer (int32)
|
nullable | — | — |
country
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | — | — |
details
|
— | JsonObject primitive | — | |
displayName
|
string
|
nullable | — | — |
environment
|
string
|
nullable | — | — |
id
|
integer (int32)
|
nullable | — | — |
isActive
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
name
|
string
|
nullable | — | — |
publicUrl
|
string
|
nullable | — | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic