Harness

Project Secrets [Beta]

This contains APIs for project-scoped secrets.

Create a secret

Creates a new secret

Securityx-api-key
Request
path Parameters
org
required
string

Identifier field of the organization the resource is scoped to

project
required
string

Identifier field of the project the resource is scoped to

query Parameters
private_secret
boolean
Default: false

This would be used to define secret as private.

header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to.

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

Secret response

post/v1/orgs/{org}/projects/{project}/secrets
Request samples
{
  • "secret": {
    }
}
Response samples
{
  • "secret": {
    },
  • "created": 1234567890,
  • "updated": 1234567890,
  • "draft": false
}

List secrets

Retrieves the information of the secrets.

Securityx-api-key
Request
path Parameters
org
required
string

Identifier field of the organization the resource is scoped to

project
required
string

Identifier field of the project the resource is scoped to

query Parameters
secret
Array of strings

Identifier field of secrets

type
Array of strings

Secret types on which the filter will be applied

Items Enum: "SSHKeyPath" "SSHKeyReference" "SSHPassword" "SSHKerberosTGTKeyTabFile" "SSHKerberosTGTPassword" "SecretFile" "SecretText" "WinRmTGTKeyTabFile" "WinRmTGTPassword" "WinRmNTLM"
recursive
boolean
Default: false

Expand current scope to include all child scopes

search_term
string

This would be used to filter resources having attributes matching with search term.

page
integer
Default: 0

Pagination page number strategy: Specify the page number within the paginated collection related to the number of items in each page

limit
integer <= 1000
Default: 20

Number of items to return per page.

sort
string

Parameter on the basis of which sorting is done.

Enum: "name" "identifier" "created" "updated"
order
string

Order on the basis of which sorting is done.

Enum: "ASC" "DESC"
header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to.

Responses
200

Secret list response

get/v1/orgs/{org}/projects/{project}/secrets
Request samples 
Response samples 
[
  • {
    }
]
Validate secret reference
Validates if the secret at the secretManager path can be referenced


Securityx-api-key 
Request 
path Parameters
org
required
string
Identifier field of the organization the resource is scoped to


 
project
required
string
Identifier field of the project to which the resource is scoped.


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to.


 
Request Body schema: application/json
Details of the secret reference


required
object (Secret) 
 
Responses 
200
Response of the secret reference validation 


post/v1/orgs/{org}/projects/{project}/secrets/validate-secret-ref
Request samples 
application/json
{
  • "secret_manager_identifier": "prod_sm_one",
  • "secret_ref_path": "path1/path2#key"
}
Response samples 
application/json
{
  • "success": true,
  • "message": "Validation is Successful, Secret can be referenced"
}
Retrieve a secret
Retrieves the information of the secret.


Securityx-api-key 
Request 
path Parameters
org
required
string
Identifier field of the organization the resource is scoped to


 
project
required
string
Identifier field of the project the resource is scoped to


 
secret
required
string
Identifier field of the secret


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to.


 
Responses 
200
Secret response


get/v1/orgs/{org}/projects/{project}/secrets/{secret}
Request samples 
Response samples 
{
  • "secret": {
    },
  • "created": 1234567890,
  • "updated": 1234567890,
  • "draft": false
}
Delete a secret
Deletes 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


 
project
required
string
Identifier field of the project the resource is scoped to


 
secret
required
string
Identifier field of the secret


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to.


 
Responses 
200
Secret response


delete/v1/orgs/{org}/projects/{project}/secrets/{secret}
Request samples 
Response samples 
{
  • "secret": {
    },
  • "created": 1234567890,
  • "updated": 1234567890,
  • "draft": false
}
Update a secret
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


 
project
required
string
Identifier field of the project the resource is scoped to


 
secret
required
string
Identifier field of the secret


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to.


 
Request Body schema: 
required
required
object (Secret) 
 
Responses 
200
Secret response


put/v1/orgs/{org}/projects/{project}/secrets/{secret}
Request samples 
{
  • "secret": {
    }
}
Response samples 
{
  • "secret": {
    },
  • "created": 1234567890,
  • "updated": 1234567890,
  • "draft": false
}
➔ Next to Secrets