Generated by API Evangelist
Written by API Evangelist tooling for Harness's API. It is a proposal applied on top of the contract, not a document Harness publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Backstage Harness API
version: 1.0.0
extends: openapi/harness-backstageharness-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/v1/backstage-harness/sync'].post
update:
x-apievangelist-phrasing:
intent: Sync Backstage entities for all IDP accounts
effect: write
questions:
- Can I trigger a Backstage-to-platform entity sync across every IDP-enabled account at once?
- Is there a global sync that covers all accounts, not just mine?
instructions:
- text: Sync Backstage entities for all IDP-enabled accounts.
- text: Run the global Backstage entity sync across every account.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/backstage-harness/sync/for-account'].post
update:
x-apievangelist-phrasing:
intent: Sync Backstage entities for my account
effect: write
questions:
- How do I resync Backstage catalog entities for just my account?
- Can I push Backstage entities into my account on demand?
instructions:
- text: Sync Backstage entities for my account only.
- text: Re-run the Backstage sync for this single account.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/backstage-harness/sync/for-entity'].post
update:
x-apievangelist-phrasing:
intent: Sync one Backstage entity
effect: write
questions:
- Can I sync a single Backstage entity instead of the whole catalog?
- What actions and sync modes are available when syncing one entity?
instructions:
- text: Sync Backstage entity {entity_identifier} with action {action} in mode {sync_mode}.
slots:
entity_identifier: requestBody.entity_identifier
action: requestBody.action
sync_mode: requestBody.sync_mode
- text: Resync entity {entity_identifier} on behalf of user {user}.
slots:
entity_identifier: requestBody.entity_identifier
user: requestBody.user
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.