Repository credentials

Create creates a new repository credential

Create creates a new repository credential.

SecurityApiKey
Request
path Parameters
agentIdentifier
required
string

Agent identifier for entity.

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

identifier
string
Request Body schema: application/json
object (RepoCreds holds the definition for repository credentials)
upsert
boolean (Whether to create in upsert mode)
Responses
200

A successful response.

default

An unexpected error response.

post/gitops/api/v1/agents/{agentIdentifier}/repocreds
Request samples
application/json
{
  • "creds": {
    },
  • "upsert": true
}
Response samples
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "identifier": "string",
  • "repoCreds": {
    },
  • "createdAt": {
    },
  • "lastModifiedAt": {
    },
  • "stale": true
}

Delete deletes a repository credential

Delete deletes a repository credential.

SecurityApiKey
Request
path Parameters
agentIdentifier
required
string

Agent identifier for entity.

identifier
required
string
query Parameters
accountIdentifier
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

query.url
string

Repo URL for query.

query.repoCredsType
string

RepoCreds type - git or helm.

Responses
200

A successful response.

default

An unexpected error response.

delete/gitops/api/v1/agents/{agentIdentifier}/repocreds/{identifier}
Request samples
Response samples
application/json
{ }

Get returns a repository credential given its identifier

Get returns a repository credential given its identifier.

SecurityApiKey
Request
path Parameters
agentIdentifier
required
string

Agent identifier for entity.

identifier
required
string
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

query.url
string

Repo URL for query.

query.repoCredsType
string

RepoCreds type - git or helm.

Responses
200

A successful response.

default

An unexpected error response.

get/gitops/api/v1/agents/{agentIdentifier}/repocreds/{identifier}
Request samples
Response samples
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "identifier": "string",
  • "repoCreds": {
    },
  • "createdAt": {
    },
  • "lastModifiedAt": {
    },
  • "stale": true
}

Get returns a repository credential given its url

Get returns a repository credential given its url.

SecurityApiKey
Request
path Parameters
agentIdentifier
required
string

Agent identifier for entity.

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

identifier
string
Request Body schema: application/json
url
string (Repo URL for query)
repoCredsType
string (RepoCreds type - git or helm)
Responses
200

A successful response.

default

An unexpected error response.

post/gitops/api/v1/agents/{agentIdentifier}/repocreds/get
Request samples
application/json
{
  • "url": "string",
  • "repoCredsType": "string"
}
Response samples
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "identifier": "string",
  • "repoCreds": {
    },
  • "createdAt": {
    },
  • "lastModifiedAt": {
    },
  • "stale": true
}

List repository credentials

List repository credentials.

SecurityApiKey
Request
Request Body schema: application/json
accountIdentifier
string

Account Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

agentIdentifier
string

Agent identifier for entity.

identifier
string
searchTerm
string
pageSize
integer <int32>
pageIndex
integer <int32>
filter
object

Filters for Repo Credentials. Eg. "identifier": { "$in": ["id1", "id2"]

Responses
200

A successful response.

default

An unexpected error response.

post/gitops/api/v1/repocreds
Request samples
application/json
{
  • "accountIdentifier": "string",
  • "projectIdentifier": "string",
  • "orgIdentifier": "string",
  • "agentIdentifier": "string",
  • "identifier": "string",
  • "searchTerm": "string",
  • "pageSize": 0,
  • "pageIndex": 0,
  • "filter": { }
}
Response samples
application/json
{
  • "content": [
    ],
  • "totalPages": 0,
  • "totalItems": 0,
  • "pageItemCount": 0,
  • "pageSize": 0,
  • "pageIndex": 0,
  • "empty": true
}

Update updates a repository credential

Update updates a repository credential.

SecurityApiKey
Request
path Parameters
agentIdentifier
required
string

Agent identifier for entity.

identifier
required
string
query Parameters
accountIdentifier
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

Request Body schema: application/json
object (RepoCreds holds the definition for repository credentials)
Responses
200

A successful response.

default

An unexpected error response.

put/gitops/api/v1/agents/{agentIdentifier}/repocreds/{identifier}
Request samples
application/json
{
  • "creds": {
    }
}
Response samples
application/json
{
  • "accountIdentifier": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "agentIdentifier": "string",
  • "identifier": "string",
  • "repoCreds": {
    },
  • "createdAt": {
    },
  • "lastModifiedAt": {
    },
  • "stale": true
}