Search

Endpoints related to search functionality on a hub.

Get Search Index

Gets a pre-built search index, containing IDs and basic information for many commonly used resources on the Hub. Can be used to build a 'quick search' functionality for referencing the most frequently used resources.

Requires the view capability for each returned segment, i.e. to retrieve Containers, you must have containers-view.

SecuritybearerAuth

Responses

200

Returns an indexed search matrix.

default

General error response from the platform

get/v1/search/index

Response samples

200
default

application/json

{"data": {"generated": "2021-01-30T08:30:00Z",
"hub_id": "string",
"containers": {"property1": {"id": "string",
"name": "string",
"identifier": "string",
"state": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
},
"context_blobs": ["string"
],
"associations": {"container": "string",
"environment": "string",
"image-source": "string",
"image": "string",
"stack": "string",
"server": "string",
"provider-location": "string"
}
},
"property2": {"id": "string",
"name": "string",
"identifier": "string",
"state": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
},
"context_blobs": ["string"
],
"associations": {"container": "string",
"environment": "string",
"image-source": "string",
"image": "string",
"stack": "string",
"server": "string",
"provider-location": "string"
}
}
},
"environments": {"property1": {"id": "string",
"name": "string",
"identifier": "string",
"state": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
},
"context_blobs": ["string"
],
"associations": {"container": "string",
"environment": "string",
"image-source": "string",
"image": "string",
"stack": "string",
"server": "string",
"provider-location": "string"
}
},
"property2": {"id": "string",
"name": "string",
"identifier": "string",
"state": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
},
"context_blobs": ["string"
],
"associations": {"container": "string",
"environment": "string",
"image-source": "string",
"image": "string",
"stack": "string",
"server": "string",
"provider-location": "string"
}
}
},
"image_sources": {"property1": {"id": "string",
"name": "string",
"identifier": "string",
"state": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
},
"context_blobs": ["string"
],
"associations": {"container": "string",
"environment": "string",
"image-source": "string",
"image": "string",
"stack": "string",
"server": "string",
"provider-location": "string"
}
},
"property2": {"id": "string",
"name": "string",
"identifier": "string",
"state": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
},
"context_blobs": ["string"
],
"associations": {"container": "string",
"environment": "string",
"image-source": "string",
"image": "string",
"stack": "string",
"server": "string",
"provider-location": "string"
}
}
},
"dns_zones": {"property1": {"id": "string",
"name": "string",
"identifier": "string",
"state": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
},
"context_blobs": ["string"
],
"associations": {"container": "string",
"environment": "string",
"image-source": "string",
"image": "string",
"stack": "string",
"server": "string",
"provider-location": "string"
}
},
"property2": {"id": "string",
"name": "string",
"identifier": "string",
"state": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
},
"context_blobs": ["string"
],
"associations": {"container": "string",
"environment": "string",
"image-source": "string",
"image": "string",
"stack": "string",
"server": "string",
"provider-location": "string"
}
}
},
"stacks": {"property1": {"id": "string",
"name": "string",
"identifier": "string",
"state": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
},
"context_blobs": ["string"
],
"associations": {"container": "string",
"environment": "string",
"image-source": "string",
"image": "string",
"stack": "string",
"server": "string",
"provider-location": "string"
}
},
"property2": {"id": "string",
"name": "string",
"identifier": "string",
"state": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
},
"context_blobs": ["string"
],
"associations": {"container": "string",
"environment": "string",
"image-source": "string",
"image": "string",
"stack": "string",
"server": "string",
"provider-location": "string"
}
}
},
"servers": {"property1": {"id": "string",
"name": "string",
"identifier": "string",
"state": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
},
"context_blobs": ["string"
],
"associations": {"container": "string",
"environment": "string",
"image-source": "string",
"image": "string",
"stack": "string",
"server": "string",
"provider-location": "string"
}
},
"property2": {"id": "string",
"name": "string",
"identifier": "string",
"state": "string",
"events": {"property1": "2021-01-30T08:30:00Z",
"property2": "2021-01-30T08:30:00Z"
},
"context_blobs": ["string"
],
"associations": {"container": "string",
"environment": "string",
"image-source": "string",
"image": "string",
"stack": "string",
"server": "string",
"provider-location": "string"
}
}
}
}
}

➔ Next to Stacks