Create Integration Async

Create an integration in the current organization asynchronously

Request

URI

POST

https://vra-interop-222-139.lvn.broadcom.net/iaas/api/integrations

COPY

Query Parameters

string

apiVersion

Required

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

string

validateOnly

Optional

Only validate provided Integration Specification. Integration will not be created.

Request Body

Integration instance

IntegrationSpecification of type(s) application/json

Required

Show optional properties

{
    "name": "string",
    "integrationType": "Active directory, Ansible, IPAM, vRO, GitHub",
    "integrationProperties": {}
}

{
    "name": "string",
    "description": "string",
    "integrationType": "Active directory, Ansible, IPAM, vRO, GitHub",
    "privateKeyId": "ACDC55DB4MFH6ADG75KK",
    "privateKey": "gfsScK345sGGaVdds222dasdfDDSSasdfdsa34fS",
    "integrationProperties": {
        "supportPublicImages": "true",
        "acceptSelfSignedCertificate": "true"
    },
    "associatedCloudAccountIds": [
        "42f3e0d199d134755684cd935435a"
    ],
    "customProperties": {
        "sampleadapterProjectId": "projectId"
    },
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ],
    "certificateInfo": {
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIDHjCCAoegAwIBAgIBATANBgkqhkiG9w0BAQsFADCBpjEUMBIGA1UEChMLVk13\nYXJlIEluYAAc1pw18GT3iAqQRPx0PrjzJhgjIJMla\n/1Kg4byY4FPSacNiRgY/FG2bPCqZk1yRfzmkFYCW/vU+Dg==\n-----END CERTIFICATE-----\n-"
    }
}

string

name

Required

A human-friendly name used as an identifier in APIs that support this option.

string

description

Optional

A human-friendly description.

string

integrationType

Required

Integration type

string

privateKeyId

Optional

Access key id or username to be used to authenticate with the integration

string

privateKey

Optional

Secret access key or password to be used to authenticate with the integration

object

integrationProperties

Required

Integration specific properties supplied in as name value pairs

array of string

associatedCloudAccountIds

Optional

Cloud accounts to associate with this integration

object

customProperties

Optional

Additional custom properties that may be used to extend the Integration.

array of object

tags

Optional

A set of tag keys and optional values to set on the Integration

object

certificateInfo

Optional

Specification for certificate for a cloud account.

Authentication

This operation uses the following authentication methods.

Authorization

Responses

202

Accepted

Returns RequestTracker of type(s) application/json

"RequestTracker Object"

integer As int32 As int32

progress

Required

Progress of the request as percentage.

string

message

Optional

Status message of the request.

string

status

Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,

array of string

resources

Optional

Collection of resources.

string

name

Optional

Name of the operation.

string

Required

ID of this request.

string

selfLink

Required

Self link of this request.

string

deploymentId

Optional

ID of the deployment, this request is connected to.

400

Invalid Request - bad data

Returns ServiceErrorResponse of type(s) application/json

"ServiceErrorResponse Object"

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

403

Forbidden

Returns ServiceErrorResponse of type(s) application/json

"ServiceErrorResponse Object"

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"integrationProperties:"object","integrationType:"string","name:"string"}' https://{api_host}/iaas/api/integrations

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Integration Operations

GET

Get Integrations