GuidesAPI Reference
API Reference

Make a resource Linkable

post
https://Use API Lookup for a base URL/resources//linkable

Adds a listing to make this resource linkable to either a project or entire realm. The resource must belong to a project to be made linkable. Either projectHrn or realmHrn must be provided to make the resource linkable to.


Access Control:

  • The calling principal must have permission to take all the "requiredToMakeLinkable" actions against the service inferred via the reserved resource prefix of the resource in the path in the scope of the home project of the resource.
  • This API works only with tokens that are scoped to the home project of the resource.
  • This API does not support the resources of type "pipeline".
Path Params
string
required

The hrn that identifies the resource.

Body Params
string
required

The hrn of the resource

string

The hrn of the project that the resource is made linkable to

string

The hrn of the project that the resource is made linkable to

allowedActions
array of strings
required

The list of actions made available for referencing for the resourceType. These actions must be one of the "projectLinkingEnabled" actions of the service inferred via the reserved resource prefix of the resource in the path.

allowedActions*
Headers
string

Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated.

Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago