Authentication
Connections
AWS
Guard Rails
Server Management
Jira
Organization Management
Reports
User Management
Sessions
Get DB Role Job
Get DB Role job by id
curl --request GET \
--url https://use.hoop.dev/api/dbroles/jobs/{id}{
"completed_at": "2025-02-28T13:45:12Z",
"created_at": "2025-02-28T12:34:56Z",
"id": "67D7D053-3CAF-430E-97BA-6D4933D3FD5B",
"org_id": "37EEBC20-D8DF-416B-8AC2-01B6EB456318",
"spec": {
"account_arn": "arn:aws:iam:123456789012",
"db_arn": "arn:aws:rds:us-west-2:123456789012:db:my-instance",
"db_engine": "postgres",
"db_name": "customers",
"db_tags": [
{
"key": "squad",
"value": "banking"
}
]
},
"status": {
"message": "All user roles have been successfully provisioned",
"phase": "running",
"result": [
{
"completed_at": "2025-02-28T12:34:56Z",
"credentials_info": {
"secret_id": "dbsecrets/data",
"secret_keys": [
"HOST",
"PORT",
"USER",
"PASSWORD",
"DB"
],
"secrets_manager_provider": "database"
},
"message": "process already being executed, resource_id=arn:aws:rds:us-west-2:123456789012:db:my-postgres-db",
"status": "failed",
"user_role": "hoop_ro"
}
]
}
}Path Parameters
The unique identifier of the resource
Response
Timestamp when this job finished execution (null if still in progress)
"2025-02-28T13:45:12Z"
Timestamp when this job was initially created
"2025-02-28T12:34:56Z"
Unique identifier for this database role job
"67D7D053-3CAF-430E-97BA-6D4933D3FD5B"
Unique identifier of the organization that owns this job
"37EEBC20-D8DF-416B-8AC2-01B6EB456318"
AWS-specific configuration details for the database role provisioning
AWS IAM ARN with permissions to execute this role creation job
"arn:aws:iam:123456789012"
ARN of the target RDS database instance where roles will be created
"arn:aws:rds:us-west-2:123456789012:db:my-instance"
Database engine type (e.g., "postgres", "mysql") of the RDS instance
"postgres"
Logical database name within the RDS instance where roles will be applied
"customers"
Current status and results of the job execution (null if not started)
Human-readable description of the overall job status or error details
"All user roles have been successfully provisioned"
Current execution phase of the job: "running", "failed", or "completed"
running, failed, completed "running"
Detailed results for each individual role that was provisioned
Timestamp when this specific role's provisioning completed
"2025-02-28T12:34:56Z"
Credentials information about the stored secrets
The secret identifier that contains the secret data. This value is always empty for the database type.
"dbsecrets/data"
The keys that were saved in the secrets manager. This value is always empty for the database type.
["HOST", "PORT", "USER", "PASSWORD", "DB"]
The secrets manager provider that was used to store the credentials
database, vault "database"
Human-readable description of this role's provisioning status or error details
"process already being executed, resource_id=arn:aws:rds:us-west-2:123456789012:db:my-postgres-db"
Status of this specific role's provisioning: "running", "failed", or "completed"
running, failed, completed "failed"
Name of the specific database role that was provisioned
"hoop_ro"
curl --request GET \
--url https://use.hoop.dev/api/dbroles/jobs/{id}{
"completed_at": "2025-02-28T13:45:12Z",
"created_at": "2025-02-28T12:34:56Z",
"id": "67D7D053-3CAF-430E-97BA-6D4933D3FD5B",
"org_id": "37EEBC20-D8DF-416B-8AC2-01B6EB456318",
"spec": {
"account_arn": "arn:aws:iam:123456789012",
"db_arn": "arn:aws:rds:us-west-2:123456789012:db:my-instance",
"db_engine": "postgres",
"db_name": "customers",
"db_tags": [
{
"key": "squad",
"value": "banking"
}
]
},
"status": {
"message": "All user roles have been successfully provisioned",
"phase": "running",
"result": [
{
"completed_at": "2025-02-28T12:34:56Z",
"credentials_info": {
"secret_id": "dbsecrets/data",
"secret_keys": [
"HOST",
"PORT",
"USER",
"PASSWORD",
"DB"
],
"secrets_manager_provider": "database"
},
"message": "process already being executed, resource_id=arn:aws:rds:us-west-2:123456789012:db:my-postgres-db",
"status": "failed",
"user_role": "hoop_ro"
}
]
}
}