Change the current password

PUT

/auth/password

Code sample: Shell / cURL

curl --request PUT \
  --url https://api.grepvine.ai/v1/auth/password \
  --header 'Content-Type: application/json' \
  --cookie __Host-grepvine-session=<__Host-grepvine-session> \
  --data '{ "current_password": "example", "new_password": "example" }'

Authorizations

• cookieAuth
• apiKeyAuth

Parameters

Header Parameters

X-Csrf-Token

string

>= 16 characters <= 256 characters

Required for a state change that uses cookie authentication.

Request Body^required

Media typeapplication/json

object

current_password

required

string

<= 1024 characters

new_password

required

string

>= 12 characters <= 1024 characters

Example ^generated

{
  "current_password": "example",
  "new_password": "example"
}

Responses

204

The password was changed.

401

Authentication is required or failed.

Media typeapplication/json

object

code

required

string

reason

required

string

error

required

string

Example ^generated

{
  "code": "example",
  "reason": "example",
  "error": "example"
}

Headers

X-Request-Id

string

The request identifier used for support and audit correlation.

default

The request failed. A 429 carries Retry-After; the index is busy absorbing recent writes or is out of request capacity, and clients must slow down and retry after the interval. A 403 with code organization_suspended refuses every operation on a suspended organization’s members, indexes, documents and searches; reading the organization itself still answers and reports suspended, and the client should contact support.

Media typeapplication/json

object

code

required

string

reason

required

string

error

required

string

Example ^generated

{
  "code": "example",
  "reason": "example",
  "error": "example"
}

Headers

X-Request-Id

string

The request identifier used for support and audit correlation.

Retry-After

integer

Seconds to wait before retrying. Sent with every 429 so a client slows down instead of failing.