Harness

Project [Beta]

This contains APIs for projects.

Create a project

Creates a new project

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. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Request Body schema:
required

Post the necessary fields for the API to create a project.

required
object (ProjectRequest)

Project model

Responses
201

Project response

post/v1/orgs/{org}/projects
Request samples
{
  • "project": {
    }
}
Response samples
{
  • "project": {
    },
  • "created": 1234567890,
  • "updated": 1234567890,
  • "isFavorite": true
}

List projects

Retrieves the information of the projects.

Securityx-api-key
Request
path Parameters
org
required
string

Identifier field of the organization the resource is scoped to

query Parameters
project
Array of strings

Identifier field of the projects the resource is scoped to

has_module
boolean
Default: true

This boolean specifies whether to filter projects which has the module of type passed in the moduleType parameter or not

module_type
string

Project's module type

only_favorites
boolean

Enable this field to fetch only the entities that are marked as favorites.

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. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Responses
200

Project list response

get/v1/orgs/{org}/projects
Request samples 
Response samples 
[
  • {
    }
]
Retrieve a project
Retrieves the information of the project with the matching project 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


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Responses 
200
Project response


get/v1/orgs/{org}/projects/{project}
Request samples 
Response samples 
{
  • "project": {
    },
  • "created": 1234567890,
  • "updated": 1234567890,
  • "isFavorite": true
}
Update a project
Updates the information of the project with the matching project 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


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Request Body schema: 
required
Put the necessary fields for the API to update a Project.


required
object (ProjectRequest) 
Project model


 
Responses 
200
Project response


put/v1/orgs/{org}/projects/{project}
Request samples 
{
  • "project": {
    }
}
Response samples 
{
  • "project": {
    },
  • "created": 1234567890,
  • "updated": 1234567890,
  • "isFavorite": true
}
Delete a project
Deletes the information of the project with the matching project 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


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Responses 
200
Project response


delete/v1/orgs/{org}/projects/{project}
Request samples 
Response samples 
{
  • "project": {
    },
  • "created": 1234567890,
  • "updated": 1234567890,
  • "isFavorite": true
}
➔ Next to Project