Skip to content

Commit 79c401c

Browse files
committed
update auth methods in internal api doc
1 parent 2dfd8f0 commit 79c401c

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

docs/internal/README.md

+18-19
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,13 @@ We do not recommend using internal API endpoints for anything other than their i
1313

1414
**Intended Consumer:** Diego staging task completion callback
1515

16-
**Auth Mechanism:** MTLS + Basic Auth
17-
16+
**Auth Mechanism:** mTLS
1817
### POST /internal/v3/staging/:staging_guid/build_completed
1918
**Description:** Marks build as completed or failed.
2019

2120
**Intended Consumer:** Diego staging task completion callback
2221

23-
**Auth Mechanism:** MTLS + Basic Auth
22+
**Auth Mechanism:** mTLS
2423

2524
### GET /internal/apps/:guid/ssh_access/:index
2625
**Description:** Check if a user is able to ssh into a process container
@@ -34,49 +33,49 @@ We do not recommend using internal API endpoints for anything other than their i
3433

3534
**Intended Consumer:** ??? (Probably intended for Diego staging task, but it looks like they use direct download from the blobstore now)
3635

37-
**Auth Mechanism:** Basic Auth
36+
**Auth Mechanism:** mTLS
3837

3938
### GET /staging/packages/:guid
4039
**Description:** Download a package if the blobstore is local (NFS server mounted on the CC)
4140

4241
**Intended Consumer:** Diego staging task
4342

44-
**Auth Mechanism:** Basic Auth
43+
**Auth Mechanism:** mTLS
4544

4645
### GET /staging/v3/droplets/:guid/download
4746
**Description:** Download a droplet if the blobstore is local (NFS server mounted on the CC)
4847

4948
**Intended Consumer:** Diego running task or process
5049

51-
**Auth Mechanism:** Basic Auth
50+
**Auth Mechanism:** mTLS
5251

5352
### GET /staging/v3/buildpack_cache/:stack/:app_guid/download
5453
**Description:** Download buildpack cache for a given stack and app combination
5554

5655
**Intended Consumer:** Diego staging task
5756

58-
**Auth Mechanism:** Basic Auth
57+
**Auth Mechanism:** mTLS
5958

6059
### GET /internal/v2/droplets/:guid/:droplet_checksum/download
6160
**Description:** (Deprecated) Permalink for downloading a droplet. Use `GET /internal/v4/droplets/:guid/:droplet_checksum/download` instead.
6261

6362
**Intended Consumer:** Diego running task or process
6463

65-
**Auth Mechanism:** None (redirects to MTLS endpoint if CC is configured for MTLS)
64+
**Auth Mechanism:** mTLS
6665

6766
### GET /internal/v4/droplets/:guid/:droplet_checksum/download
6867
**Description:** Permalink for downloading a droplet.
6968

7069
**Intended Consumer:** Diego running task or process
7170

72-
**Auth Mechanism:** MTLS
71+
**Auth Mechanism:** mTLS
7372

7473
### POST /internal/v4/apps/:process_guid/crashed
7574
**Description:** Create crash audit event for process
7675

7776
**Intended Consumer:** TPS Watcher
7877

79-
**Auth Mechanism:** MTLS
78+
**Auth Mechanism:** mTLS
8079

8180
### GET /internal/v4/log_access/:app_guid
8281
**Description:** Check if a user has access to the log stream for an app
@@ -90,60 +89,60 @@ We do not recommend using internal API endpoints for anything other than their i
9089

9190
**Intended Consumer:** Bits Service
9291

93-
**Auth Mechanism:** MTLS
92+
**Auth Mechanism:** mTLS
9493

9594
### GET /internal/v4/syslog_drain_urls
9695
**Description:** Return list of syslog drain urls from logging services
9796

9897
**Intended Consumer:** Loggregator
9998

100-
**Auth Mechanism:** MTLS
99+
**Auth Mechanism:** mTLS
101100

102101
### GET /internal/v5/syslog_drain_urls
103102
**Description:** Return list of syslog drain urls from logging services. Intends to replace v4 version.
104103

105104
**Intended Consumer:** Loggregator
106105

107-
**Auth Mechanism:** MTLS
106+
**Auth Mechanism:** mTLS
108107

109108
### POST /internal/v4/tasks/:task_guid/completed
110109
**Description:** Marks task as complete
111110

112111
**Intended Consumer:** Application task running on Diego cell
113112

114-
**Auth Mechanism:** MTLS
113+
**Auth Mechanism:** mTLS
115114

116115
### POST /internal/v4/droplets/:guid/upload
117116
**Description:** Uploads droplet
118117

119118
**Intended Consumer:** CC Uploader
120119

121-
**Auth Mechanism:** MTLS + Basic Auth
120+
**Auth Mechanism:** mTLS
122121

123122
### GET /internal/v4/staging_jobs/:guid
124123
**Description:** Returns progress of droplet upload job
125124

126125
**Intended Consumer:** CC Uploader
127126

128-
**Auth Mechanism:** MTLS + Basic Auth
127+
**Auth Mechanism:** mTLS
129128

130129
### POST /internal/v4/buildpack_cache/:stack_name/:guid/upload
131130
**Description:** Uploads buildpack cache for a stack name and app guid
132131

133132
**Intended Consumer:** CC Uploader
134133

135-
**Auth Mechanism:** MTLS + Basic Auth
134+
**Auth Mechanism:** mTLS
136135

137136
### POST /internal/v4/metrics
138137
**Description:** Returns CAPI metrics
139138

140139
**Intended Consumer:** Prom Scraper
141140

142-
**Auth Mechanism:** MTLS
141+
**Auth Mechanism:** mTLS
143142

144143
### GET /internal/v4/asg_latest_update
145144
**Description:** Returns timestamp of the last Application Security Group update
146145

147146
**Intended Consumer:** Diego
148147

149-
**Auth Mechanism:** MTLS
148+
**Auth Mechanism:** mTLS

0 commit comments

Comments
 (0)