Organization Connectors [Beta]

This contains APIs for Organization-scoped Connectors.

Create a Connector

Creates a new connector

Securityx-api-key
Request
path Parameters
org
required
string

Identifier field of the organization the resource is scoped to

header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to.

Request Body schema:
required
required
object (Connector)
Responses
201

Connector response

post/v1/orgs/{org}/connectors
Request samples
{
  • "connector": {
    }
}
Response samples
{
  • "connector": {
    },
  • "created": 1234567890,
  • "updated": 1234567890
}

Retrieve a connector

Retrieves the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE.

Securityx-api-key
Request
path Parameters
org
required
string

Identifier field of the organization the resource is scoped to

connector
required
string

Connector identifier

header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to.

Responses
200

Connector response

get/v1/orgs/{org}/connectors/{connector}
Request samples
Response samples
{
  • "connector": {
    },
  • "created": 1234567890,
  • "updated": 1234567890
}

Update a connector

Updates the information of the secret with the matching secret identifier.

Securityx-api-key
Request
path Parameters
org
required
string

Identifier field of the organization the resource is scoped to

connector
required
string

Connector identifier

header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to.

Request Body schema:
required
required
object (Connector)
Responses
200

Connector response

put/v1/orgs/{org}/connectors/{connector}
Request samples
{
  • "connector": {
    }
}
Response samples
{
  • "connector": {
    },
  • "created": 1234567890,
  • "updated": 1234567890
}

Delete a connector

Deletes the information of the connector with the matching connector identifier. Connector types supported are GIT, ARTIFACTORY, APP_DYNAMICS and AZURE.

Securityx-api-key
Request
path Parameters
org
required
string

Identifier field of the organization the resource is scoped to

connector
required
string

Connector identifier

header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to.

Responses
200

OK

delete/v1/orgs/{org}/connectors/{connector}
Request samples

Test a connector

Tests connection of the connector with the matching connector identifier.

Securityx-api-key
Request
path Parameters
org
required
string

Identifier field of the organization the resource is scoped to

connector
required
string

Connector identifier

header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to.

Responses
200

This has test connection details for the Connector defined in Harness.

get/v1/orgs/{org}/connectors/{connector}/test-connection
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "errors": [
    ],
  • "error_summary": "string",
  • "tested_at": 0,
  • "delegate_id": "string"
}