Get Org Product
GET/v1/org/:org_identifier/product/:product_identifier
Get a product by ID or short name, requires product:config:view | product:config:edit permission
Request
Path Parameters
org_identifier anyrequired
Organization ID or short name
product_identifier anyrequired
Product ID or short name
Responses
- 200
- 422
Successful Response
- application/json
- Schema
- Example (from schema)
Schema
product_id uuidrequired
org_id uuidrequired
Organization that owns this product
name Name (string)
Official Full Name
primary_contact_email Primary Contact Email (string)
Email Address for the primary point of contact
short_name Short Name (string)required
Possible values: non-empty
Name used in URLs
unique_name Unique Name (string)
Unique name used as prefix for environment unique names
last_modified_timestamp date-timerequired
created_timestamp date-timerequired
archive Archive (boolean)required
{
"product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"primary_contact_email": "string",
"short_name": "string",
"unique_name": "string",
"last_modified_timestamp": "2024-07-29T15:51:28.071Z",
"created_timestamp": "2024-07-29T15:51:28.071Z",
"archive": true
}
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
- MOD1
- MOD2
]
]
detail
object[]
loc
object[]
required
anyOf
string
integer
msg Message (string)required
type Error Type (string)required
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}
Loading...