Skip to content
GigAI

Archive a profile

POST
/api/profiles/{profile_id}/archive
curl --request POST \
  --url http://127.0.0.1:8765/api/profiles/example/archive \
  --header 'Content-Type: application/json' \
  --data '{}'

Archive a profile, optionally moving its selection to another.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
profile_id
required
string

A profile id from GET /api/profiles.

Request Body

Section titled “Request Body”
Media typeapplication/json
object
replacement_profile_id

Profile to select instead.

string
Example
{}

Responses

Section titled “Responses”

200

Section titled “200”

Success.

Media typeapplication/json
object
key
additional properties
any
Example
{
  "archived": "prof_1"
}

400

Section titled “400”

Invalid_value

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Example
{
  "error": {
    "code": "invalid_value",
    "message": "..."
  }
}

403

Section titled “403”

Forbidden / forbidden_origin: loopback peer and Host 127.0.0.1:<port> or localhost:<port> only (Origin too on writes).

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Examplegenerated
{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

404

Section titled “404”

Not_found

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Example
{
  "error": {
    "code": "not_found",
    "message": "..."
  }
}

415

Section titled “415”

Unsupported_media_type: writes need Content-Type: application/json.

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Examplegenerated
{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}