Skip to content

Conversation

@oh4real
Copy link

@oh4real oh4real commented Jun 17, 2019

…ruct

Description

I added an optional custom_origin_server property to the CustomHostname struct so the cloudflare-go client can be used to create this special custom hostname.

Has your change been tested?

I added a new test for the optional property. go test ran successfully.

Screenshots (if appropriate):

Types of changes

What sort of change does your code introduce/modify?

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • [] My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

??? If https://godoc.org/github.com/cloudflare/cloudflare-go#CustomHostname is auto-generated, then it should show up. If not, instructions would be helpful.

@jacobbednarz
Copy link
Contributor

Thanks for the PR @oh4real. I'm not seeing this field in the public API documentation. If you're seeing this in a response, are you able to raise a support ticket to get the documentation updated and confirm this is something that is intended to be used by the end users?

@oh4real
Copy link
Author

oh4real commented Jun 17, 2019

It's complicated. And no, like many, many things, is not in api.cloudflare.com

It's in the SSL for SAAS (Enterprise) docs: https://developers.cloudflare.com/ssl/ssl-for-saas/hostname-specific/hostname-specific/ This is publicly accessible, even though only available to Enterprise configured zones.

Also, if you are enterprise, when you go to create a custom host via the Admin console, it is an option:
image

I have submitted a ticket to support for them to add this the enterprise feature to the API docs.

Also, we've been using the property/feature for almost a year with our in-house cloudflare client.

@jacobbednarz
Copy link
Contributor

Appreciate the context. We've got this enabled on our Enterprise account and see what you've mentioned above.

The main caveat here we need to look out for is that if it's not documented, we don't really have a leg to stand on if something is changed unexpectedly. This isn't something the Cloudflare folks generally do but it's a good practice not to rely on anything that isn't publicly documented to avoid random breakages.

Keep us posted on the ticket status and if you hit any issues, we can ping some Cloudflare folks to either advise or take a look at getting some eyes on it.

@oh4real
Copy link
Author

oh4real commented Jun 17, 2019

I got a response from the support team.

Un/fortunately, the request has gone into an internal ticketing system for the API team, so I have no visibility on when/if the property/feature will ever make it into the official API.

Hi there,
Thanks for contacting Cloudflare support. My name is Andrew and I will be looking into this ticket for you.

Thank you for the information, I have created a ticket for our API team with the details in your ticket, asking them to update the documentation. 

However, I have no ETA on when this will be completed.I will mark this as solved, but do let us know if you have any further questions or issues by replying to this e-mail or ticket.

Best regards,
Andrew B

They closed the ticket, so I don't think I should expect any updates to it.

I am open to suggestions on how to proceed?

@jacobbednarz
Copy link
Contributor

@oh4real it looks like the documentation for this has been updated. If you can fix up the minor formatting issues here, we can look to get this one merged.

oh4real and others added 3 commits July 24, 2019 09:46
Co-Authored-By: Jacob Bednarz <jacob.bednarz@gmail.com>
Co-Authored-By: Jacob Bednarz <jacob.bednarz@gmail.com>
@oh4real
Copy link
Author

oh4real commented Jul 26, 2019

I missed your note on docs. I've updated per your formatting suggestions. Hopefully, branch is good.

Copy link
Contributor

@jacobbednarz jacobbednarz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM 👏 @patryk any concerns with this one?

@patryk
Copy link

patryk commented Aug 22, 2019

Thanks for contribution @oh4real and my apologies for the delay in response.

@patryk patryk merged commit 74099a0 into cloudflare:master Aug 22, 2019
Michael9127 pushed a commit to Michael9127/cloudflare-go that referenced this pull request Oct 28, 2019
cloudflare#316)

* CUSTOM_ORIGIN_SERVER Adding custom_origin_server to CustomHostname struct

* Update custom_hostname_test.go

Co-Authored-By: Jacob Bednarz <jacob.bednarz@gmail.com>

* Update custom_hostname_test.go

Co-Authored-By: Jacob Bednarz <jacob.bednarz@gmail.com>

* CUSTOM_ORIGIN_SERVER Not sure how json got so ugly
@aeneasr
Copy link

aeneasr commented Oct 21, 2025

Hello, this is no longer available on the v6 branch, which is very unfortunate!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants