Projects

List Projects

get

Responses

200

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/accounts

GET /v1/accounts HTTP/1.1
Host: 
Accept: */*

{
  "accounts": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "additionalInfo": {
          "documentation": [
            {
              "text": "text",
              "url": "text"
            }
          ],
          "message": "string"
        },
        "blueprintTags": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "dateModified": "text",
        "deprecated": true,
        "description": "string",
        "displayName": "string",
        "hash": "text",
        "icon": "string",
        "id": "string",
        "labels": {},
        "name": "string",
        "resourceDocLink": "string",
        "stability": "string",
        "version": 1,
        "warning": "string"
      },
      "spec": {
        "alternateSecretKeys": [
          "text"
        ],
        "parameters": [
          {
            "credential": true,
            "name": "text",
            "sensitive": true,
            "value": null
          }
        ],
        "secretKey": "text"
      },
      "status": {}
    }
  ]
}

Create a new project

post

Body

stringOptional

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post

/accounts

POST /v1/accounts HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

{
  "account": {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
      "additionalInfo": {
        "documentation": [
          {
            "text": "text",
            "url": "text"
          }
        ],
        "message": "string"
      },
      "blueprintTags": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "dateModified": "text",
      "deprecated": true,
      "description": "string",
      "displayName": "string",
      "hash": "text",
      "icon": "string",
      "id": "string",
      "labels": {},
      "name": "string",
      "resourceDocLink": "string",
      "stability": "string",
      "version": 1,
      "warning": "string"
    },
    "spec": {
      "alternateSecretKeys": [
        "text"
      ],
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "secretKey": "text"
    },
    "status": {}
  }
}

Update Project Metadata

patch

Body

stringOptional

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

patch

/accounts

PATCH /v1/accounts HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

{
  "account": {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
      "additionalInfo": {
        "documentation": [
          {
            "text": "text",
            "url": "text"
          }
        ],
        "message": "string"
      },
      "blueprintTags": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "dateModified": "text",
      "deprecated": true,
      "description": "string",
      "displayName": "string",
      "hash": "text",
      "icon": "string",
      "id": "string",
      "labels": {},
      "name": "string",
      "resourceDocLink": "string",
      "stability": "string",
      "version": 1,
      "warning": "string"
    },
    "spec": {
      "alternateSecretKeys": [
        "text"
      ],
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "secretKey": "text"
    },
    "status": {}
  }
}

patch

Responses

204

No Content - Project switched successfully

401

Unauthorized - User does not have permission to switch project

application/json

403

Forbidden - User does not have permission to switch project

application/json

500

Internal Server Error - Failed to switch project or other server errors

application/json

patch

/accounts/current

PATCH /v1/accounts/current HTTP/1.1
Host: 
Accept: */*

No content

get

Path parameters

idstringRequired

the id of the project

Responses

200

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/accounts/{id}

GET /v1/accounts/{id} HTTP/1.1
Host: 
Accept: */*

{
  "account": {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
      "additionalInfo": {
        "documentation": [
          {
            "text": "text",
            "url": "text"
          }
        ],
        "message": "string"
      },
      "blueprintTags": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "dateModified": "text",
      "deprecated": true,
      "description": "string",
      "displayName": "string",
      "hash": "text",
      "icon": "string",
      "id": "string",
      "labels": {},
      "name": "string",
      "resourceDocLink": "string",
      "stability": "string",
      "version": 1,
      "warning": "string"
    },
    "spec": {
      "alternateSecretKeys": [
        "text"
      ],
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "secretKey": "text"
    },
    "status": {}
  }
}

Delete project by id

delete

Path parameters

idstringRequired

the id of the project to delete

Responses

204

Successful Delete, no content

401

Unauthorized

application/json

404

Not Found

application/json

409

Conflict

application/json

428

Precondition Required

application/json

500

Internal Server Error

application/json

delete

/accounts/{id}

DELETE /v1/accounts/{id} HTTP/1.1
Host: 
Accept: */*

No content

List Projects

get

Responses

200

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/projects

GET /v1/projects HTTP/1.1
Host: 
Accept: */*

{
  "accounts": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "additionalInfo": {
          "documentation": [
            {
              "text": "text",
              "url": "text"
            }
          ],
          "message": "string"
        },
        "blueprintTags": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "dateModified": "text",
        "deprecated": true,
        "description": "string",
        "displayName": "string",
        "hash": "text",
        "icon": "string",
        "id": "string",
        "labels": {},
        "name": "string",
        "resourceDocLink": "string",
        "stability": "string",
        "version": 1,
        "warning": "string"
      },
      "spec": {
        "alternateSecretKeys": [
          "text"
        ],
        "parameters": [
          {
            "credential": true,
            "name": "text",
            "sensitive": true,
            "value": null
          }
        ],
        "secretKey": "text"
      },
      "status": {}
    }
  ]
}

Create a new project

post

Body

stringOptional

Responses

201

Created

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post

/projects

POST /v1/projects HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

{
  "account": {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
      "additionalInfo": {
        "documentation": [
          {
            "text": "text",
            "url": "text"
          }
        ],
        "message": "string"
      },
      "blueprintTags": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "dateModified": "text",
      "deprecated": true,
      "description": "string",
      "displayName": "string",
      "hash": "text",
      "icon": "string",
      "id": "string",
      "labels": {},
      "name": "string",
      "resourceDocLink": "string",
      "stability": "string",
      "version": 1,
      "warning": "string"
    },
    "spec": {
      "alternateSecretKeys": [
        "text"
      ],
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "secretKey": "text"
    },
    "status": {}
  }
}

Update Project Metadata

patch

Body

stringOptional

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

patch

/projects

PATCH /v1/projects HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

{
  "account": {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
      "additionalInfo": {
        "documentation": [
          {
            "text": "text",
            "url": "text"
          }
        ],
        "message": "string"
      },
      "blueprintTags": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "dateModified": "text",
      "deprecated": true,
      "description": "string",
      "displayName": "string",
      "hash": "text",
      "icon": "string",
      "id": "string",
      "labels": {},
      "name": "string",
      "resourceDocLink": "string",
      "stability": "string",
      "version": 1,
      "warning": "string"
    },
    "spec": {
      "alternateSecretKeys": [
        "text"
      ],
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "secretKey": "text"
    },
    "status": {}
  }
}

patch

Responses

204

No Content - Project switched successfully

401

Unauthorized - User does not have permission to switch project

application/json

403

Forbidden - User does not have permission to switch project

application/json

500

Internal Server Error - Failed to switch project or other server errors

application/json

patch

/projects/current

PATCH /v1/projects/current HTTP/1.1
Host: 
Accept: */*

No content

patch

Sets the next login project for the user

Responses

204

No Content - Next login project set successfully

401

Unauthorized - User does not have permission to set next login project

application/json

403

Forbidden - User does not have permission to set next login project

application/json

500

Internal Server Error - Failed to set next login project or other server errors

application/json

patch

/projects/next-login

PATCH /v1/projects/next-login HTTP/1.1
Host: 
Accept: */*

No content

get

Path parameters

idstringRequired

the id of the project

Responses

200

application/json

401

Unauthorized

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

/projects/{id}

GET /v1/projects/{id} HTTP/1.1
Host: 
Accept: */*

{
  "account": {
    "apiVersion": "string",
    "kind": "string",
    "metadata": {
      "additionalInfo": {
        "documentation": [
          {
            "text": "text",
            "url": "text"
          }
        ],
        "message": "string"
      },
      "blueprintTags": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "dateModified": "text",
      "deprecated": true,
      "description": "string",
      "displayName": "string",
      "hash": "text",
      "icon": "string",
      "id": "string",
      "labels": {},
      "name": "string",
      "resourceDocLink": "string",
      "stability": "string",
      "version": 1,
      "warning": "string"
    },
    "spec": {
      "alternateSecretKeys": [
        "text"
      ],
      "parameters": [
        {
          "credential": true,
          "name": "text",
          "sensitive": true,
          "value": null
        }
      ],
      "secretKey": "text"
    },
    "status": {}
  }
}

Delete project by id

delete

Path parameters

idstringRequired

the id of the project to delete

Responses

204

Successful Delete, no content

401

Unauthorized

application/json

404

Not Found

application/json

409

Conflict

application/json

428

Precondition Required

application/json

500

Internal Server Error

application/json

delete

/projects/{id}

DELETE /v1/projects/{id} HTTP/1.1
Host: 
Accept: */*

No content

PreviousEula NextAgent Type

Last updated 4 days ago

Was this helpful?

Good morning

List Projects

Create a new project

Update Project Metadata

Delete project by id

List Projects

Create a new project

Update Project Metadata

Set Next Login Project

Delete project by id