Skip to main content
PUT
/
machineidentities
/
{name}
Update Machine Identity
curl --request PUT \
  --url https://use.hoop.dev/api/machineidentities/{name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "backend-prod",
  "attributes": [
    "env:prod",
    "team:backend"
  ],
  "connection_names": [
    "prod-postgres",
    "api-proxy"
  ],
  "description": "Production backend service identity"
}
'
{
  "name": "backend-prod",
  "attributes": [
    "env:prod",
    "team:backend"
  ],
  "connection_names": [
    "prod-postgres",
    "api-proxy"
  ],
  "created_at": "2024-07-25T15:56:35.317601Z",
  "description": "Production backend service identity",
  "id": "BF997324-5A27-4778-806A-41EE83598494",
  "new_credentials": [
    {
      "aws_access_key_id": "<string>",
      "aws_secret_access_key": "<string>",
      "command": "<string>",
      "connection_name": "<string>",
      "connection_string": "<string>",
      "connection_subtype": "<string>",
      "connection_type": "<string>",
      "database_name": "<string>",
      "endpoint_url": "<string>",
      "hostname": "<string>",
      "password": "<string>",
      "port": "<string>",
      "proxy_token": "<string>",
      "secret_key": "<string>",
      "username": "<string>"
    }
  ],
  "updated_at": "2024-07-25T15:56:35.317601Z"
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.hoop.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
name
string
required

Machine Identity Name

Body

application/json

The request body resource

​
name
string
required
Example:

"backend-prod"

​
attributes
string[]
Example:
["env:prod", "team:backend"]
​
connection_names
string[]
Example:
["prod-postgres", "api-proxy"]
​
description
string
Example:

"Production backend service identity"

Response

OK

​
name
string
required
Example:

"backend-prod"

​
attributes
string[]
Example:
["env:prod", "team:backend"]
​
connection_names
string[]
Example:
["prod-postgres", "api-proxy"]
​
created_at
string
read-only
Example:

"2024-07-25T15:56:35.317601Z"

​
description
string
Example:

"Production backend service identity"

​
id
string<uuid>
read-only
Example:

"BF997324-5A27-4778-806A-41EE83598494"

​
new_credentials
object[]
​
updated_at
string
read-only
Example:

"2024-07-25T15:56:35.317601Z"