Update Project Metadata

POST 
/v1/project/update/:project_id

deprecated

Edit project metadata.

Request

Path Parameters

project_id anyrequired

application/json

Body

required

id Id (string)required

The project id

project_name

object

Project name to update

anyOf

MOD1

string

description

object

Project description to update

anyOf

MOD1

string

is_public

object

Should the project be public?

anyOf

MOD1

boolean

is_public_to_org

object

Should the project be shared to the organization?

anyOf

MOD1

boolean

slug

object

A new slug to use in project urls.

anyOf

MOD1

string

privacy

object

The privacy of the project

anyOf

MOD1

string

Possible values: [public, with_link, private, restricted]

Responses

200

Successful Response

application/json

Schema

Schema

result Result (string)

Default value: ok

Example (from schema)

{
  "result": "ok"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...