Get an entity

GET 
https://api.port.io/v1/blueprints/:blueprint_identifier/entities/:entity_identifier

This route allows you to fetch a specific entity in your software catalog.

To learn more about entities, check out the documentation.

Request

Path Parameters

entity_identifier stringrequired

Possible values: non-empty

The identifier of the entity you want to fetch.


blueprint_identifier stringrequired

Possible values: non-empty

The identifier of the blueprint the entity belongs to.

Query Parameters

exclude_calculated_properties boolean
If true, calculated properties will be excluded from the entity.

Default value: false
include string[]

An array of values from the entity JSON. Only these values will be returned in the response.
For example: { "properties.propertyIdentifier","identifier"}

exclude string[]

An array of values from the entity JSON to be ommitted from the response.
For example: { "properties.propertyIdentifier","identifier"}

Responses

200

Success

404

One of the following errors occurred:

Error	Description
not_found	An entity with the provided `identifier` was not found
not_found	A blueprint with the provided `identifier` was not found

422

One of the following errors occurred:

Error	Description
invalid_request	The provided data does not match the route schema

500

One of the following errors occurred:

Error	Description
internal_error	An internal error occurred

Authorization: Authorization

name: Authorizationtype: apiKeyscopes: read:entitiesin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.port.io/v1/blueprints/:blueprint_identifier/entities/:entity_identifier");
request.Headers.Add("Authorization", "<Authorization>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.port.io

Auth

bearer

Parameters

entity_identifier — pathrequired

blueprint_identifier — pathrequired

exclude_calculated_properties — query

---truefalse

include — query

exclude — query

ResponseClear

Click the Send API Request button above and see the response here!